From 7a0c3113563d82efc7238d9fbffdb3a6e76ce472 Mon Sep 17 00:00:00 2001 From: bijayasharma Date: Thu, 12 Nov 2020 16:55:01 -0500 Subject: [PATCH] Add ClusterAPIRef related documentation 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 Relates-To: #376 --- docs/source/phases.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/source/phases.rst b/docs/source/phases.rst index bbc29cbbb..998ef8830 100644 --- a/docs/source/phases.rst +++ b/docs/source/phases.rst @@ -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 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 API object source code @@ -357,6 +365,9 @@ Example of cluster map workload01: parent: target-cluster dynamicKubeConf: true + clusterAPIRef: + name: workload01 + namespace: tenant01-namespace Metadata file -------------