docs: DOC-1027 DOC-1028 Add layer constraint info to pack-constraints…

….md (#2055) (#2058) * Add layer constraint info to pack-constraints.md Add required layer constraint and layer choices * Update pack-constraints.md Fix reviewdog issues * docs: table suggestion * docs: DOC-1027 DOC-1028 more examples * update table descirptions * Remove text * docs: minor changes * docs: vale feedback --------- Co-authored-by: Sheldon Lo-A-Njoe <[email protected]>
spectrocloud · Jan 17, 2024 · a9995da · a9995da
1 parent c86251a
commit a9995da
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 56 deletions.
diff --git a/docs/docs-content/clusters/public-cloud/gcp/add-gcp-accounts.md b/docs/docs-content/clusters/public-cloud/gcp/add-gcp-accounts.md
@@ -21,10 +21,10 @@ Palette supports integration with Google Cloud Platform (GCP) accounts. This sec
 
     - [Compute Admin](https://cloud.google.com/iam/docs/understanding-roles#compute.admin)
 
-    - [Service Account User](https://cloud.google.com/iam/docs/understanding-roles#iam.serviceAccountUser)
-
     - [Storage Object Viewer](https://cloud.google.com/iam/docs/understanding-roles#storage.objectViewer)
 
+    - [Service Account Token Creator](https://cloud.google.com/iam/docs/understanding-roles#iam.serviceAccountTokenCreator)
+
     <br />
 
     :::info

diff --git a/docs/docs-content/registries-and-packs/pack-constraints.md b/docs/docs-content/registries-and-packs/pack-constraints.md
@@ -244,18 +244,21 @@ Pack dependency constraints must be defined in the `pack.json` file. The sample
     "dependencies": [
       {
         "packName": "vault",
+        "layer": "addon",
         "minVersion": "0.6.0",
         "maxVersion": "",
         "type": "optional"
       },
       {
         "packName": "csi-vsphere-volume",
+        "layer": "csi",
         "minVersion": "1.0.0",
         "maxVersion": "",
         "type": "notSupported"
       },
       {
         "packName": "kubernetes",
+        "layer": "k8s",
         "minVersion": "1.17.0",
         "maxVersion": "1.18.6",
         "type": "required"
@@ -275,71 +278,70 @@ If the minimum and maximum versions are not mentioned, the validation is skipped
 
 ## Pack Dependency Attributes
 
-<Tabs queryString="Pack Dependency Attributes">
+A pack can have one or more dependencies defined in the `dependencies` array. Each dependency consists of the following attributes.
 
-<TabItem label="packName" value="pack_dependency_attribute_packName">
 
-Name of the dependent pack.
-
-**Example**: In the example, the three dependent packs are identified by unique pack names such as `vault`, `csi-vsphere-volume`, and `kubernetes`.
-
-</TabItem>
-
-<TabItem label="minVersion" value="pack_dependency_attribute_minVersion">
-
-Minimum supported dependent pack version, any version below the minimum version is not valid.
-
-**Example**: pack `pack-constraints-test` must require pack `vault` of min version `0.6.0`.
-
-</TabItem>
-
-<TabItem label="maxVersion" value="pack_dependency_attribute_maxVersion">
-
-Maximum supported dependent pack version, any version above the maximum version is not valid.
-
-**Example**: pack `pack-constraints-test` must require pack `kubernetes` of min version `1.18.6`.
-
-</TabItem>
-
-<TabItem label="type" value="pack_dependency_attribute_type">
-
-<Tabs queryString="Pack dependency types">
-
-<TabItem label="optional" value="pack_dependency_optional">
-
-The dependent pack is optional but validates minimum or maximum versions if the pack is selected.
-
-**Example**: `vault` pack is optional.
-
-</TabItem>
-
-<TabItem label="required" value="pack_dependency_required">
-
-The dependent pack is mandatory and must contain a version within the minimum or maximum supported versions, if defined.
-
-**Example**: `kubernetes` pack must be required of min version `1.17.0` and max version `1.18.6`. Any Kubernetes version below `1.17.0` and above `1.18.6` is not valid.
-
-</TabItem>
-
-<TabItem label="notSupported" value="pack_dependency_notSupported">
+| Attribute | Description |
+|-------|-------------|
+| `packName` | Name of the dependent pack. |
+| `layer`  | The layer type of the dependent pack. Refer to the [Layer Types](#layer-types) section to learn more. |
+| `minVersion`  | Minimum supported dependent pack version, any version below the minimum version is not valid. |
+| `maxVersion`  | Maximum supported dependent pack version, any version above the maximum version is not valid. |
+| `type`  | The defined type for the dependency. Refer to the [Dependency Types](#dependency-types) section to learn more.|
+
+
+In the example code snippet from earlier, the three dependent packs are identified by unique pack names such as `vault`, `csi-vsphere-volume`, and `kubernetes`. A `minVersion`, `maxVersion`, and `type` are defined for each dependent pack.
+
+```json {3,10,17} hideClipboard
+"dependencies": [
+    {
+      "packName": "vault",
+      "layer": "addon",
+      "minVersion": "0.6.0",
+      "maxVersion": "",
+      "type": "optional"
+    },
+    {
+      "packName": "csi-vsphere-volume",
+      "layer": "csi",
+      "minVersion": "1.0.0",
+      "maxVersion": "",
+      "type": "notSupported"
+    },
+    {
+      "packName": "kubernetes",
+      "layer": "k8s",
+      "minVersion": "1.17.0",
+      "maxVersion": "1.18.6",
+      "type": "required"
+    }
+  ]
+```
 
-Pack versions within the range of the mentioned minimum and maximum (including the minimum and maximum) are not supported.
 
-**Example**: `csi-vsphere-volume` pack is not supported if the version selected falls within the min and max versions.
+#### Layer Types
 
-:::info
+The `layer` attribute defines the layer where the dependent pack can be found in the Cluster Profile. The following table lists the different layer types.
 
-If the minimum and maximum versions are not mentioned, the validation is skipped and all versions are allowed.
+| Layer | Description |
+|-------|-------------|
+| `os` | The dependent pack can only be found in the operating system layer of the Cluster Profile. The `os` layer contains packs such as Ubuntu, CentOS or Bring Your Own OS (BYOOS). |
+| `k8s`  | The dependent pack can only be found in the Kubernetes layer of the Cluster Profile. The `k8s` layer contains packs such as [Palette eXtended Kubernetes](../integrations/kubernetes.md), RKE2, k3s or MicroK8s. |
+| `cni`  | The dependent pack can only be found in the network layer of the Cluster Profile. The `cni` layer contains packs such as Calico, Cilium, Flannel and Antrea. |
+| `csi`  | The dependent pack can only be found in the storage layer of the Cluster Profile. The `csi` layer contains packs such as vSphere CSI, Amazon EBS CSI, Amazon EFS, Azure Disk and Portworx.|
+| `addon`  | The dependent pack can only be found in the add-on layers of the Cluster Profile. The `addon` layer contains packs such as ArgoCD, Vault, Nginx, and many more. |
 
-:::
 
-</TabItem>
+#### Dependency Types
 
-</Tabs>
+The `type` attribute defines the type of dependency. The following table lists the different dependency types.
 
-</TabItem>
+| Type | Description |
+|-------|-------------|
+| `optional` | The dependent pack is optional but validates minimum or maximum versions if the pack is selected. In the example, the `vault` pack is optional. |
+| `required`  | The dependent pack is mandatory and must contain a version within the minimum or maximum supported versions, if defined. In the example, the `kubernetes` pack is required with a minimum version of `1.17.0` and a max version of `1.18.6`. Any Kubernetes version below `1.17.0` and above `1.18.6` is not valid. |
+| `notSupported`  | The pack versions within the range of the mentioned minimum and maximum are not supported. The `csi-vsphere-volume` pack is not supported if the version selected falls within the min and max versions. |
 
-</Tabs>
 
 ## Pack Resource Constraints