airshipctl/docs/source/cli/airshipctl_cluster_init.md
Drew Walters 0d7dc4de24 Add automated CLI documentation
This change creates a tool that generates CLI documentation each time
`make update-golden` is executed.

Change-Id: I4bcdf299cd424f4cff1ecf6503822d304e9a3947
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-05-13 19:43:10 +00:00

1.7 KiB

airshipctl cluster init

Deploy cluster-api provider components

Synopsis

Initialize cluster-api providers based on airshipctl document set. document set must contain document of Kind: Clusterctl in phase initinfra. Path to initinfra phase is built based on airshipctl config <manifest.target-path>//ephemeral/initinfra. Clusterctl document example:

apiVersion: airshipit.org/v1alpha1 kind: Clusterctl metadata: labels: airshipit.org/deploy-k8s: "false" name: clusterctl-v1 init-options: core-provider: "cluster-api:v0.3.3" bootstrap-providers: - "kubeadm:v0.3.3" infrastructure-providers: - "metal3:v0.3.1" control-plane-providers: - "kubeadm:v0.3.3" providers:

  • name: "metal3" type: "InfrastructureProvider" versions: v0.3.1: manifests/function/capm3/v0.3.1
  • name: "kubeadm" type: "BootstrapProvider" versions: v0.3.3: manifests/function/cabpk/v0.3.3
  • name: "cluster-api" type: "CoreProvider" versions: v0.3.3: manifests/function/capi/v0.3.3
  • name: "kubeadm" type: "ControlPlaneProvider" versions: v0.3.3: manifests/function/cacpk/v0.3.3
airshipctl cluster init [flags]

Examples


# Initialize clusterctl providers and components
airshipctl cluster init

Options

  -h, --help   help for init

Options inherited from parent commands

      --airshipconf string   Path to file for airshipctl configuration. (default "$HOME/.airship/config")
      --debug                enable verbose output
      --kubeconfig string    Path to kubeconfig associated with airshipctl configuration. (default "$HOME/.airship/kubeconfig")

SEE ALSO