airship/airshipctl
Code Issues Proposed changes

Fixed error message and typos in docs file

Browse Source 
* 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 <vetbijaya@gmail.com>
Change-Id: Ic37df3151c33559db971fc85a41c540281828de0
This commit is contained in:
bijayasharma 2021-06-10 20:07:50 +00:00 committed by Bijaya Sharma
parent 3544c96249
commit 2278f01bf0
6 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/hardware_profile.md
View File

@ -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.

4
docs/source/providers/cluster_api_azure.md
View File

@ -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

6
docs/source/providers/cluster_api_docker.md
View File

@ -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

8
docs/source/providers/cluster_api_gcp.md
View File

@ -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

4
docs/source/providers/cluster_api_openstack.md
View File

@ -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](<https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/docs/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 <public network>` command.

12
docs/source/secrets-guidelines.md
View File

@ -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