From 2278f01bf0cd13ef17be54883c8b1de419a99f52 Mon Sep 17 00:00:00 2001 From: bijayasharma Date: Thu, 10 Jun 2021 20:07:50 +0000 Subject: [PATCH] Fixed error message and typos in docs file * This commit will fix capitalization of error message in templater.go file * And will also fix typos in some of the docs file Signed-off-by: bijayasharma Change-Id: Ic37df3151c33559db971fc85a41c540281828de0 --- docs/source/hardware_profile.md | 2 +- docs/source/providers/cluster_api_azure.md | 4 ++-- docs/source/providers/cluster_api_docker.md | 6 +++--- docs/source/providers/cluster_api_gcp.md | 8 ++++---- docs/source/providers/cluster_api_openstack.md | 4 ++-- docs/source/secrets-guidelines.md | 12 ++++++------ 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/source/hardware_profile.md b/docs/source/hardware_profile.md index 2d2e9a1c1..3ed13f8da 100644 --- a/docs/source/hardware_profile.md +++ b/docs/source/hardware_profile.md @@ -14,7 +14,7 @@ a large set of BMH documents efficiently. ## The Example Hardware Profile -A Hardware Profile, in airshiptl terms, is a collection of parameters that +A Hardware Profile, in airshipctl terms, is a collection of parameters that comprise a hardware level configuration of a server. Currently, it contains RAID and firmware configurations. And later, this can be extended. diff --git a/docs/source/providers/cluster_api_azure.md b/docs/source/providers/cluster_api_azure.md index d77542fe8..1e756062c 100644 --- a/docs/source/providers/cluster_api_azure.md +++ b/docs/source/providers/cluster_api_azure.md @@ -36,7 +36,7 @@ CAPZ components. $ airshipctl cluster init ``` ## Deploy Target cluster on Azure -To deploy the Target cluster on Azure cloude execute the following command. +To deploy the Target cluster on Azure cloud execute the following command. ```bash $ airshipctl phase apply azure-target ``` @@ -122,7 +122,7 @@ Now we can trigger the configuration of Calico on the Target Cluster $ airshipctl phase apply calico --kubeconfig az-target-cluster.kubeconfig ``` -Once the Calico provisionning has been completed you should see all the nodes instantiated for the +Once the Calico provisioning has been completed you should see all the nodes instantiated for the Target cluster in Ready state. ```bash $ kubectl --kubeconfig=./az-target-cluster.kubeconfig get nodes diff --git a/docs/source/providers/cluster_api_docker.md b/docs/source/providers/cluster_api_docker.md index 338867dac..e95064e83 100755 --- a/docs/source/providers/cluster_api_docker.md +++ b/docs/source/providers/cluster_api_docker.md @@ -41,10 +41,10 @@ Get multiple contexts for every cluster in the airship site Initialize CNI on target cluster` > airshipctl phase run initinfra-networking-target -Initialize Target Cluster with cluster api and docker proivder components +Initialize Target Cluster with cluster api and docker provider components > airshipctl phase run clusterctl-init-target -Move managment CRDs from kind management cluster to target management cluster +Move management CRDs from kind management cluster to target management cluster > airshipctl phase run clusterctl-move Use target management cluster to deploy workers @@ -229,7 +229,7 @@ software and version, provided in this section. #### Virtual Machine Specification -All the instructions in the document were perfomed on a Oracle Virtual Box(6.1) +All the instructions in the document were performed on a Oracle Virtual Box(6.1) VM running Ubuntu 18.04.4 LTS (Bionic Beaver) with 16G of memory and 4 VCPUs #### Docker diff --git a/docs/source/providers/cluster_api_gcp.md b/docs/source/providers/cluster_api_gcp.md index 220d9bcc4..a85e52434 100755 --- a/docs/source/providers/cluster_api_gcp.md +++ b/docs/source/providers/cluster_api_gcp.md @@ -41,10 +41,10 @@ Get multiple contexts for every cluster in the airship site Initialize CNI on target cluster` > airshipctl phase run initinfra-networking-target -Initialize Target Cluster with cluster api and gcp proivder components +Initialize Target Cluster with cluster api and gcp provider components > airshipctl phase run clusterctl-init-target -Move managment CRDs from kind management cluster to target management cluster +Move management CRDs from kind management cluster to target management cluster > airshipctl phase run clusterctl-move Use target management cluster to deploy workers @@ -108,7 +108,7 @@ cluster-api-ubuntu-1804-v1-17-11-1607489276 airship-gcp capi-ubuntu-1804-k8s-v ### Create Cloud NAT Router Kubernetes nodes, to communicate with the control plane, pull container images -from registried (e.g. gcr.io or dockerhub) need to have NAT access or a public +from registered (e.g. gcr.io or dockerhub) need to have NAT access or a public ip. By default, the provider creates Machines without a public IP. To make sure your cluster can communicate with the outside world, and the load @@ -421,7 +421,7 @@ software and version, provided in this section. #### Virtual Machine Specification -All the instructions in the document were perfomed on a Oracle Virtual Box(6.1) +All the instructions in the document were performed on a Oracle Virtual Box(6.1) VM running Ubuntu 18.04.4 LTS (Bionic Beaver) with 16G of memory and 4 VCPUs #### Docker diff --git a/docs/source/providers/cluster_api_openstack.md b/docs/source/providers/cluster_api_openstack.md index c62c81781..c1cac1092 100755 --- a/docs/source/providers/cluster_api_openstack.md +++ b/docs/source/providers/cluster_api_openstack.md @@ -51,7 +51,7 @@ components: ### Credentials -In order to comunicate with openstack cloud environment, following set of credentials are +In order to communicate with openstack cloud environment, following set of credentials are needed to be generated. The [env.rc]() script @@ -97,7 +97,7 @@ openstack network list --external ### Floating IP A floating IP is automatically created and associated with the load balancer or controller node, however floating IP can also be -specified explicitly by setting the `spec.apiServerLoadBalancerFlotingIP` of `OpenStackCluster` CRD. +specified explicitly by setting the `spec.apiServerLoadBalancerFloatingIP` of `OpenStackCluster` CRD. Floating ip can be created using `openstack floating ip create ` command. diff --git a/docs/source/secrets-guidelines.md b/docs/source/secrets-guidelines.md index b3811b596..ca77b5d74 100644 --- a/docs/source/secrets-guidelines.md +++ b/docs/source/secrets-guidelines.md @@ -182,7 +182,7 @@ When this template is executed it generates keys/certs/passwords and renders the Please pay attention that the special annotation `config.kubernetes.io/path` is getting added in the fileplacement transformer - it defines the name of the file where this document will be stored by phase. It’s possible to define several VariableCatalogues with unique names of files (it even may contain directories). -Now if we refer back to the Phase descritption we’ll see that it’s type is GenericContainer with the name `encrypter`. +Now if we refer back to the Phase description we’ll see that it’s type is GenericContainer with the name `encrypter`. The definition of that executor is the following: @@ -215,7 +215,7 @@ Basically this executor accepts the bundle, runs krm-function `gcr.io/kpt-fn-con There is another a separate set of secrets that are provided externally and that shouldn't be generated. They're called `externally provided secrets`. For that set there is a separate folder in the target/encrypted/results, called `imported`. -There is a speical phase called `secret-import` that may be used to update the set of externally provided secrets: +There is a special phase called `secret-import` that may be used to update the set of externally provided secrets: just put a new unencrypted secrets.yaml to target/encrypted/results/imported/ instead of encrypted one and run that phase. This phase will encrypt that file using provided public key set by `SOPS_IMPORT_PGP` and `SOPS_PGP_FP`. @@ -250,7 +250,7 @@ There are 2 different approaches that may be used: Both approaches are possible taking into account that fact that SOPS allows you to have several private keys to decrypt data and it selects the needed one automatically. -Nevertheless for the sake of simplicity we're currently implemented the first approach in our manifests. There is a phase called `secret-reecnrypt` that allows to perform master key rotation. +Nevertheless for the sake of simplicity we're currently implemented the first approach in our manifests. There is a phase called `secret-reencrypt` that allows to perform master key rotation. In order to do so please follow the following steps: @@ -262,16 +262,16 @@ gpg --full-generate-key ``` Note: please make sure you know the fingerprint of the newly generated key. -2. append the env variable `SOPS_IMPORT_PGP` with the new keypair (don't delete the prvious one at this step, because it's needed for decryption). +2. append the env variable `SOPS_IMPORT_PGP` with the new keypair (don't delete the previous one at this step, because it's needed for decryption). 3. set the env variable `SOPS_PGP_FP` to the value of the NEW private key fingerprint. That means that the new key will be used for encryption. -4. run `airshipctl phase run secret-reecnrypt`. make sure it runs successfully. +4. run `airshipctl phase run secret-reencrypt`. make sure it runs successfully. 5. check that all encrypted files were updated and that pgp.fp field for all of them equal to the value you specified in `SOPS_PGP_FP`. 6. now it's possible to delete the old master key from `SOPS_IMPORT_PGP`. Once done it's possible to run `airshipctl phase run secret-show` to ensure that the keys will be decrypted properly. 8. commit the changes to the site manifests. # Troubleshooting typical cases -Note: In order to make troubleshotting possible please set env variable `DEBUG_SOPS_GPG=true` to see all debug output. +Note: In order to make troubleshooting possible please set env variable `DEBUG_SOPS_GPG=true` to see all debug output. ## Validate keys fingerprints