Design doc for bring-your-own-host#901
Conversation
|
@4everming, you must sign our contributor license agreement before your changes are merged. Click here to sign the agreement. If you are a VMware employee, read this for further instruction. |
vuil
left a comment
vuil
left a comment
There was a problem hiding this comment.
Thanks for the addition. This has the potential of opening up the CLI to logs of other deployment scenarios!
Will take another pass at this later, but here are some inital comments and minor language suggestions.
|
|
||
| ## High-Level Design | ||
|
|
||
| This is to descirbe what will be targeted for the first phase. |
| Update BOM files to support BYOH. | ||
|
|
||
| Update the logic to validate the configurations for provisioning BYOH clusters. | ||
|
|
There was a problem hiding this comment.
Documenting an invocation of tanzu cluster create with some example input will go a long way into explaining how the new functionality is going to be consumed.
| ## Goals | ||
|
|
||
| * Define the configurations used for BYOH to create BYOH workload cluster. | ||
| * Use the existing Tanzu cluster create command to create BYOH workload cluster using the configuration file. |
There was a problem hiding this comment.
| * Use the existing Tanzu cluster create command to create BYOH workload cluster using the configuration file. | |
| * Use the existing ```tanzu cluster create``` command to create BYOH workload cluster using the configuration file. |
|
|
||
| * Define the configurations used for BYOH to create BYOH workload cluster. | ||
| * Use the existing Tanzu cluster create command to create BYOH workload cluster using the configuration file. | ||
| * Use the existing Tanzu cluster list/delete/scale command to list/delete/update BYOH workload cluster. |
There was a problem hiding this comment.
| * Use the existing Tanzu cluster list/delete/scale command to list/delete/update BYOH workload cluster. | |
| * Use the existing ```tanzu cluster list/delete/scale``` commands to list/delete/update BYOH workload cluster. |
| @@ -0,0 +1,59 @@ | |||
| # Bring your own host enhancement design | |||
There was a problem hiding this comment.
| # Bring your own host enhancement design | |
| # Bring-Your-Own-Host Design |
|
|
||
| ## Abstract | ||
|
|
||
| The Bring Your Own Host aka BYOH aims at enabling Kubernetes cluster life cycle management on user provided hosts (most of the case are bare metal hosts). |
There was a problem hiding this comment.
| The Bring Your Own Host aka BYOH aims at enabling Kubernetes cluster life cycle management on user provided hosts (most of the case are bare metal hosts). | |
| The Bring Your Own Host aka BYOH aims at enabling Kubernetes cluster life cycle management on user-provided hosts (bare metal hosts in most cases). |
|
|
||
| The Bring Your Own Host aka BYOH aims at enabling Kubernetes cluster life cycle management on user provided hosts (most of the case are bare metal hosts). | ||
|
|
||
| But currently only 1 infrastructure provider is supported in tanzu-framework, this is to enhance current tanzu-framework so that users can use tanzu CLI to create BYOH workload cluster. |
There was a problem hiding this comment.
I am not sure I understand this. Can you clarify?
4everming
force-pushed
the
bringyourownhost-design-doc
branch
3 times, most recently
from
9d59048 to
cffe6e3
Compare
|
@4everming, VMware has approved your signed contributor license agreement. |
|
|
||
| This is to describe what will be targeted for the first phase. | ||
|
|
||
| To deploy a Kubernetes cluster, you create a configuration file that specifies the different options with which to deploy the cluster. You then run the tanzu cluster create command, specifying the configuration file in the ```--file``` option. |
There was a problem hiding this comment.
It is my understanding that the crawl phase involves an out-of-band step where an existing (currently vSphere-based only) management cluster needs to be updated with the byoh provider. Please provide some details to these steps, so it will be clearer the following steps involves creating a workload cluster against this byoh-enabled management cluster.
| ```WORKER_MACHINE_COUNT: 5``` | ||
|
|
||
|
|
||
| 3. Save the configuration file as my-byoh-tkc.yaml. |
There was a problem hiding this comment.
A sample of a minimal viable BYOH workload cluster config file would be very helpful when reviewing the ytt overlays for any discreptancies.
vuil
left a comment
vuil
left a comment
There was a problem hiding this comment.
Thanks for the updates. I think a clearer sequence of steps including the management cluster preparation would clarify how the crawl phase works.
4everming
force-pushed
the
bringyourownhost-design-doc
branch
2 times, most recently
from
0bd1c23 to
2fb890e
Compare
vuil
changed the title
There was a problem hiding this comment.
Thanks for updating the design doc. It is a lot clearer now what the current and upcoming phases will set out to accomplish. I took the liberty of clarifying the title and linking back to the issue filed.
The doc lgtm, but it needs some tweaking to conform to the markdown linting we are doing on all markdown files. Please take a look at the issues raised by the lint checks and address them.
Details on what is expected is also mentioned in the output of the Lint checker logs, but repeated here:
https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
4everming
force-pushed
the
bringyourownhost-design-doc
branch
from
2fb890e to
8063995
Compare
Thanks Vui for let me know that |
3 participants
What this PR does / why we need it
Introduce document to describe the plan to support bring-your-own-host provider in tanzu-framework.
Which issue(s) this PR fixes
Related to: #823
Describe testing done for PR
Release note
PR Checklist
Additional information
Special notes for your reviewer