Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Docs - workload clusters #1086

Merged
merged 8 commits into from
Jul 15, 2021
Merged

Docs - workload clusters #1086

merged 8 commits into from
Jul 15, 2021

Conversation

kcoriordan
Copy link
Contributor

@kcoriordan kcoriordan commented Jul 15, 2021

@stmcginnis
This replaces PR: #909
909 was a PR in to the docs branch,. I have completed suggested updates in 909. I have closed that PR now and this PR merging to main replaces it

Adding workload cluster content
closes: #907

@github-actions github-actions bot added the owner/docs Work executed by VMware documentation team label Jul 15, 2021
@jpmcb jpmcb marked this pull request as draft July 15, 2021 14:27
@jpmcb jpmcb changed the title WIP- workload clusters [Docs] workload clusters Jul 15, 2021
@kcoriordan kcoriordan changed the title [Docs] workload clusters Docs - workload clusters Jul 15, 2021
@kcoriordan kcoriordan requested a review from stmcginnis July 15, 2021 15:24
@stmcginnis stmcginnis marked this pull request as ready for review July 15, 2021 15:31
Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more minor things I think it would be good to update.


1. Make a copy of the management cluster configuration file and save it with a new name.
1. Open the new YAML cluster configuration file in a text editor.
1. Set a name for the cluster in the `CLUSTER_NAME` variable. If you do not specify a `CLUSTER_NAME` value in the cluster configuration file you must pass it as the first argument in the `tanzu cluster create` command. The `CLUSTER_NAME` value passed to the `tanzu cluster create` command overrides the `CLUSTER_NAME in the configuration file. Workload cluster names must be must be 42 characters or less, and must comply with DNS hostname requirements as amended in [RFC 1123](https://tools.ietf.org/html/rfc1123).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing closing backtick for the last instance of CLUSTER_NAME in this bullet.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


## Before You Begin

- Copy the configuration file: When you deploy a workload cluster, most of the configuration for the cluster is the same as the configuration of the management cluster. The easiest way to obtain an initial configuration file for a workload cluster is to make a copy of the management cluster configuration file and to update it. Locate the YAML configuration file for the management cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there are multiple sentences in this bullet, it would be good to end the last sentence with a period.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

1. Optional: Specify the number of worker nodes for the cluster in the `WORKER_MACHINE_COUNT` variable.
1. Optional: Deploy a workload cluster in a specific namespace.
If you have created namespaces, you can deploy workload clusters to those namespaces by specifying the `NAMESPACE` variable. If you do not specify the `NAMESPACE` variable, Tanzu Community Edition places clusters in the `default` namespace. Any namespace that you identify in the `NAMESPACE` variable must exist in the management cluster before you run the command. <!--For information about creating namespaces in the management cluster, see [Create Namespaces in the Management Cluster](../cluster-lifecycle/multiple-management-clusters.md#create-namespaces).--> You must provide a unique name for all workload clusters across all namespaces. If you provide a workload cluster name that is already in use in another namespace in the same instance, the deployment fails with an error.
1. Optional: To configure a workload cluster to use an OS other than the default Ubuntu v21.04, you must set the `OS_NAME` and `OS_VERSION` values in the cluster configuration file. The installer interface does not include node VM OS values in the management cluster configuration files that it saves to `~/.tanzu/tkg/clusterconfigs`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it's actually Ubuntu 20.04, not 21.04.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

- Three worker nodes, with names similar to `my-prod-cluster-md-0-2vsr4`.

## Set the Kubectl Context to the Workload Cluster {#context}
Tanzu Community Edition does not automatically set the kubectl context to a workload cluster when you create it. You must set the kubectl context to the workload cluster manually by using the kubectl config use-context command. Complete the following steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a suggestion, but it might be good to format kubectl config use-context.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@kcoriordan
Copy link
Contributor Author

@stmcginnis, thanks for review, - updates done. If there are no further updates can you merge it pls.

Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks Kay!

@stmcginnis stmcginnis merged commit d7a4101 into main Jul 15, 2021
@stmcginnis stmcginnis deleted the docs-main-workload-clusters branch July 15, 2021 19:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
owner/docs Work executed by VMware documentation team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Add doc for workload clusters
2 participants