Merge "Fixed broken links in Airshipctl docs"
This commit is contained in:
commit
9c604aecf0
@ -36,7 +36,7 @@ to cover all Airship subprojects.
|
|||||||
|
|
||||||
However, airshipctl also has its own specific coding conventions and standards
|
However, airshipctl also has its own specific coding conventions and standards
|
||||||
in the official airshipctl [developer guide](
|
in the official airshipctl [developer guide](
|
||||||
https://doc.airshipit.org/airshipctl/developers.html).
|
https://docs.airshipit.org/airshipctl/developers.html).
|
||||||
|
|
||||||
### Submitting Changes
|
### Submitting Changes
|
||||||
|
|
||||||
|
@ -183,7 +183,7 @@ Clusterctl executor document example
|
|||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
- `Executor source
|
- `Executor source
|
||||||
code <https://godoc.org/opendev.org/airship/airshipctl/pkg/clusterctl/client#ClusterctlExecutor>`__
|
code <https://pkg.go.dev/opendev.org/airship/airshipctl/pkg/phase/executors#ClusterctlExecutor>`__
|
||||||
- `Executor API object source
|
- `Executor API object source
|
||||||
code <https://godoc.org/opendev.org/airship/airshipctl/pkg/api/v1alpha1#Clusterctl>`__
|
code <https://godoc.org/opendev.org/airship/airshipctl/pkg/api/v1alpha1#Clusterctl>`__
|
||||||
|
|
||||||
@ -344,7 +344,7 @@ Cluster map is defined in `Phase bundle <#phase-bundle>`__ as a document.
|
|||||||
- `Cluster map API object source code
|
- `Cluster map API object source code
|
||||||
<https://godoc.org/opendev.org/airship/airshipctl/pkg/api/v1alpha1#ClusterMap>`__
|
<https://godoc.org/opendev.org/airship/airshipctl/pkg/api/v1alpha1#ClusterMap>`__
|
||||||
- `Cluster map interface source code
|
- `Cluster map interface source code
|
||||||
<https://godoc.org/opendev.org/airship/airshipctl/pkg/clusterctl/client#ClusterctlExecutor>`__
|
<https://pkg.go.dev/opendev.org/airship/airshipctl/pkg/phase/executors#ClusterctlExecutor>`__
|
||||||
|
|
||||||
Example of cluster map
|
Example of cluster map
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -163,7 +163,7 @@ manifests:
|
|||||||
commitHash: ""
|
commitHash: ""
|
||||||
force: false
|
force: false
|
||||||
tag: ""
|
tag: ""
|
||||||
url: https://review.opendev.org/airship/airshipctl
|
url: https://opendev.org/airship/airshipctl
|
||||||
targetPath: /tmp/airship
|
targetPath: /tmp/airship
|
||||||
default:
|
default:
|
||||||
phaseRepositoryName: primary
|
phaseRepositoryName: primary
|
||||||
|
@ -56,7 +56,7 @@ Use target management cluster to deploy workers
|
|||||||
### Build [Airshipctl](https://docs.airshipit.org/airshipctl/developers.html)
|
### Build [Airshipctl](https://docs.airshipit.org/airshipctl/developers.html)
|
||||||
|
|
||||||
```
|
```
|
||||||
$ git clone https://review.opendev.org/airship/airshipctl
|
$ git clone https://opendev.org/airship/airshipctl
|
||||||
|
|
||||||
$ cd airshipctl
|
$ cd airshipctl
|
||||||
|
|
||||||
@ -97,7 +97,7 @@ manifests:
|
|||||||
force: false
|
force: false
|
||||||
remoteRef: ""
|
remoteRef: ""
|
||||||
tag: ""
|
tag: ""
|
||||||
url: https://review.opendev.org/airship/airshipctl
|
url: https://opendev.org/airship/airshipctl
|
||||||
metadataPath: manifests/site/docker-test-site/metadata.yaml
|
metadataPath: manifests/site/docker-test-site/metadata.yaml
|
||||||
targetPath: /tmp/airship
|
targetPath: /tmp/airship
|
||||||
```
|
```
|
||||||
|
@ -202,7 +202,7 @@ manifests:
|
|||||||
force: false
|
force: false
|
||||||
remoteRef: ""
|
remoteRef: ""
|
||||||
tag: ""
|
tag: ""
|
||||||
url: https://review.opendev.org/airship/airshipctl
|
url: https://opendev.org/airship/airshipctl
|
||||||
metadataPath: manifests/site/gcp-test-site/metadata.yaml
|
metadataPath: manifests/site/gcp-test-site/metadata.yaml
|
||||||
targetPath: /tmp/airship
|
targetPath: /tmp/airship
|
||||||
```
|
```
|
||||||
|
@ -154,7 +154,7 @@ cd image-builder/images/capi/
|
|||||||
vim packer/qemu/qemu-ubuntu-1804.json
|
vim packer/qemu/qemu-ubuntu-1804.json
|
||||||
```
|
```
|
||||||
|
|
||||||
Update the iso_url to `http://cdimage.ubuntu.com/releases/18.04/release/ubuntu-18.04.5-server-amd64.iso`
|
Update the iso_url to `http://cdimage.ubuntu.com/releases/18.04/release/ubuntu-18.04.6-server-amd64.iso`
|
||||||
|
|
||||||
Make sure to use the correct checksum value from
|
Make sure to use the correct checksum value from
|
||||||
[ubuntu-releases](http://cdimage.ubuntu.com/releases/18.04.5/release/SHA256SUMS)
|
[ubuntu-releases](http://cdimage.ubuntu.com/releases/18.04.5/release/SHA256SUMS)
|
||||||
|
@ -35,7 +35,7 @@ secretGroups:
|
|||||||
pinned: true|false #optional
|
pinned: true|false #optional
|
||||||
```
|
```
|
||||||
|
|
||||||
This structure allows to split data into groups each of them can be regenerated/updated separatelly. For that purpose it has `updated` field timestamp that is getting new value when regeneration of group is happening. Each group has an array of values. Each value has a name (should be unique in the group), data field and also optional flag `pinned`. If the value is pinned, its value isn't getting updated during regeneration. That may be helpful to flexibly switch between 'internally generated' and 'externally provided' secrets. `pinned: true` will work as 'exnternally provided'.
|
This structure allows to split data into groups each of them can be regenerated/updated separately. For that purpose it has `updated` field timestamp that is getting new value when regeneration of group is happening. Each group has an array of values. Each value has a name (should be unique in the group), data field and also optional flag `pinned`. If the value is pinned, its value isn't getting updated during regeneration. That may be helpful to flexibly switch between 'internally generated' and 'externally provided' secrets. `pinned: true` will work as 'externally provided'.
|
||||||
|
|
||||||
Airshipctl will encrypt only field `data` and that will allow to monitor all other parameters without knowing master keys for decryption.
|
Airshipctl will encrypt only field `data` and that will allow to monitor all other parameters without knowing master keys for decryption.
|
||||||
|
|
||||||
@ -57,7 +57,7 @@ Airshipctl uses kustomize along with different krm-functions that extend its fun
|
|||||||
* Templater krm-function that is needed to produce new yaml documents based on the provided parameters.
|
* Templater krm-function that is needed to produce new yaml documents based on the provided parameters.
|
||||||
|
|
||||||
There is a standard catalog of [krm-functions](https://github.com/GoogleContainerTools/kpt-functions-catalog).
|
There is a standard catalog of [krm-functions](https://github.com/GoogleContainerTools/kpt-functions-catalog).
|
||||||
It includes the standard krm-function: `gcr.io/kpt-fn-contrib/sops` that can be used to perform decryption and encryption right in kustomize. Please refer to the [example configurations](https://github.com/GoogleContainerTools/kpt-functions-catalog/tree/master/examples/contrib/sops) that can be used to encrypt and decrypt the set of existing yamls.
|
It includes the standard krm-function: `gcr.io/kpt-fn-contrib/sops` that can be used to perform decryption and encryption right in kustomize. Please refer to the [example configurations](https://github.com/GoogleContainerTools/kpt-functions-catalog/tree/master/contrib/examples/sops-age) that can be used to encrypt and decrypt the set of existing yamls.
|
||||||
|
|
||||||
Please note that to make that krm-function work it’s necessary to provide the following ENV variables:
|
Please note that to make that krm-function work it’s necessary to provide the following ENV variables:
|
||||||
|
|
||||||
|
@ -131,6 +131,7 @@ For experimental/smaller setups the following method can also be used.
|
|||||||
##### Download the Redfish_tools.zip archive and build the redfish emulator VM
|
##### Download the Redfish_tools.zip archive and build the redfish emulator VM
|
||||||
|
|
||||||
[Redfish_tools.zip](https://github.com/dell-esg/tool-pkgs/blob/master/Redfish_tools.zip)
|
[Redfish_tools.zip](https://github.com/dell-esg/tool-pkgs/blob/master/Redfish_tools.zip)
|
||||||
|
Note: tools-pkgs repository have been deprecated from dell-esg so this link leads to 404
|
||||||
|
|
||||||
##### Scp the redfish_tools zip to the host machine
|
##### Scp the redfish_tools zip to the host machine
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ This function contains a Kubernetes operator which manages the lifecycle of a Ca
|
|||||||
|
|
||||||
To know more about tigera installation see the `installation reference`_.
|
To know more about tigera installation see the `installation reference`_.
|
||||||
|
|
||||||
.. _tigera-operator.yaml: https://github.com/airshipit/airshipctl/tree/master/manifests/function/tigera-operator/v1.15.0/upstream/tigera-operator.yaml
|
.. _tigera-operator.yaml: https://github.com/airshipit/airshipctl/tree/master/manifests/function/cni/tigera-operator/v1.15.0/upstream/tigera-operator.yaml
|
||||||
.. _custom-resources.yaml: https://github.com/airshipit/airshipctl/tree/master/manifests/function/tigera-operator/v1.15.0/custom-resources.yaml
|
.. _custom-resources.yaml: https://github.com/airshipit/airshipctl/tree/master/manifests/function/cni/tigera-operator/v1.15.0/custom-resources.yaml
|
||||||
.. _GitHub URL: https://docs.projectcalico.org/manifests/tigera-operator.yaml
|
.. _GitHub URL: https://docs.projectcalico.org/manifests/tigera-operator.yaml
|
||||||
.. _installation reference: https://docs.projectcalico.org/getting-started/kubernetes/quickstart
|
.. _installation reference: https://docs.projectcalico.org/getting-started/kubernetes/quickstart
|
||||||
|
Loading…
Reference in New Issue
Block a user