airship/airshipctl
Code Issues Proposed changes

Add ClusterAPIRef related documentation

Browse Source 
This commit adds documentation related to clusterAPIRef.
The PS (https://review.opendev.org/c/airship/airshipctl/+/759514)
related to this already got merged.

Change-Id: Icd372908f371b9578933d7751189af485c81070f
Signed-off-by: bijayasharma <vetbijaya@gmail.com>
Relates-To: #376
This commit is contained in:
bijayasharma 2020-11-12 16:55:01 -05:00 committed by Bijaya Sharma
parent 4aa3abd8b0
commit 7a0c311356
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/source/phases.rst
View File

@ -331,6 +331,14 @@ dynamic kubeconfig for clusters. When kubeconfig must be sourced from
a parent cluster, cluster map will be used to find parent cluster and a parent cluster, cluster map will be used to find parent cluster and
request kubeconfig from it. request kubeconfig from it.
Also, ClusterAPIRef is a part of Cluster Map and will be used to find
cluster object in kubernetes parent cluster. It also maps a clusterapi
name and namespaces for a given cluster. In the below example object,
the cluster api ref describes the reference to the cluster api object.
The cluster `workload01` in the cluster map has an clusterAPIRef to
corresponding cluster-api cluster object (kind: cluster) with name workload01
and inside namespace tenant01-namespace.
Cluster map is defined in `Phase bundle <#phase-bundle>`__ as a document. Cluster map is defined in `Phase bundle <#phase-bundle>`__ as a document.
- `Cluster map API object source code - `Cluster map API object source code
@ -357,6 +365,9 @@ Example of cluster map
workload01: workload01:
parent: target-cluster parent: target-cluster
dynamicKubeConf: true dynamicKubeConf: true
clusterAPIRef:
name: workload01
namespace: tenant01-namespace
Metadata file Metadata file
------------- -------------