Skip to content

Commit

Permalink
[release-0.18] Fix doc errors in concepts and getting started (#7198)
Browse files Browse the repository at this point in the history
* Fix doc errors in concepts and getting started

* Incorporate suggestion

---------

Co-authored-by: Saurabh Parekh <[email protected]>
  • Loading branch information
eks-distro-pr-bot and sp1999 authored Jan 21, 2024
1 parent a1d081c commit e0b9895
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/content/en/docs/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This shows examples of separate, standalone clusters:

![Standalone clusters self-manage and can run applications](/images/eks-a_cluster_standalone.png)

Once a standalone cluster is created, you have an option to use it to use it as a management cluster to create separate workload cluster(s) under it, hence making this cluster a long-lived management cluster.
Once a standalone cluster is created, you have an option to use it as a management cluster to create separate workload cluster(s) under it, hence making this cluster a long-lived management cluster.
You can only use `eksctl` to create or delete the management cluster or a standalone cluster.
This shows examples of a management cluster that deploys and manages multiple workload clusters:

Expand Down
16 changes: 8 additions & 8 deletions docs/content/en/docs/getting-started/vsphere/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Details about this config file are contained on the [vSphere Config]({{< relref

#### 3. Launch the cluster creation

Once you have modified the cluster configuration file, use `eksctl anywhere cluster create -f $CLUSTER_NAME.yaml` starts the cluster creation process.
Once you have modified the cluster configuration file, use `eksctl anywhere create cluster -f $CLUSTER_NAME.yaml` starts the cluster creation process.
To see details on the cluster creation process, increase verbosity (`-v=9` provides maximum verbosity).

#### 4. Authenticate and create bootstrap cluster
Expand All @@ -39,12 +39,12 @@ To begin, the cluster creation process runs a series of [govc](https://github.co

* Using the URL and credentials provided in the cluster spec files, authenticates to the vSphere provider.

* Validates the datacenter and the datacenter network exists:
* Validates that the datacenter and the datacenter network exists.

* Validates that the identified datastore (to store your EKS Anywhere cluster) exists, that the folder holding your EKS Anywhere cluster VMs exists, and that the resource pools containing compute resources exist.
If you have multiple `VSphereMachineConfig` objects in your config file, will see these validations repeated:
If you have multiple `VSphereMachineConfig` objects in your config file, you will see these validations repeated.

* Validates the virtual machine templates to be used for the control plane and worker nodes (such as `ubuntu-2004-kube-v1.20.7`):
* Validates the virtual machine templates to be used for the control plane and worker nodes (such as `ubuntu-2004-kube-v1.20.7`).


If all validations pass, you will see this message:
Expand Down Expand Up @@ -86,21 +86,21 @@ It uses `kubectl` to apply a target cluster configuration as follows:

* Once etcd, the control plane, and the worker nodes are ready, it applies the networking configuration to the target cluster.

* CAPI providers are configured on the target cluster, in preparation for the target cluster to take over responsibilities for running the components needed to manage the itself.
* CAPI providers are configured on the target cluster, in preparation for the target cluster to take over responsibilities for running the components needed to manage itself.

* With CAPI running on the target cluster, CAPI objects for the target cluster are moved from the bootstrap cluster to the target cluster’s CAPI service (done internally with the `clusterctl` command):
* With CAPI running on the target cluster, CAPI objects for the target cluster are moved from the bootstrap cluster to the target cluster’s CAPI service (done internally with the `clusterctl` command).

* Add Kubernetes CRDs and other addons that are specific to EKS Anywhere.

* The cluster configuration is saved:
* The cluster configuration is saved.

Once etcd, the control plane, and the worker nodes are ready, it applies the networking configuration to the workload cluster:

```
Installing networking on workload cluster
```

After that, the CAPI providers are configured on the workload cluster, in preparation for the workload cluster to take over responsibilities for running the components needed to manage the itself.
After that, the CAPI providers are configured on the workload cluster, in preparation for the workload cluster to take over responsibilities for running the components needed to manage itself:

```
Installing cluster-api providers on workload cluster
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/development-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ This documents aims to codify our development process for the most common scenar

* The solution has been implemented, it solves the original issue and follows all requirements.
* All PRs have been merged.
* All new code in properly tested.
* All new code is properly tested.
* If E2E tests were necessary, they are merged and running in CI (ideally without flakes).
* Documentation has been added (when necessary).

0 comments on commit e0b9895

Please sign in to comment.