Skip to content

Commit

Permalink
Added GKE & EKS attributes to network config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@webzakimbo
webzakimbo committed Jan 20, 2023
1 parent 9c1432c commit 15f1af5
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
10 changes: 5 additions & 5 deletions docs/source/core-concepts/nodes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This structure contextualises configuration, and allows for its re-use.

.. note::

Declared nodes can be of type: ``collection``, ``inventory``, ``inventory-subselect``, ``inventory-merge``, ``aws-k8s-cluster``, or ``gcp-k8s-cluster``
Declared nodes can be of type: ``collection``, ``inventory``, ``inventory-subselect``, ``inventory-merge``, ``eks-k8s-cluster``, or ``gke-k8s-cluster``


Declared Node Types
Expand Down Expand Up @@ -185,13 +185,13 @@ It requires contributing Inventories and/or contributing Sub-Selected-inventorie
GKE Cluster
^^^^^^^^^^^

A GKE Kubernetes Cluster, hosted in Google Cloud Platform. It is denoted by type ``gcp-k8s-cluster``.
A GKE Kubernetes Cluster, hosted in Google Cloud Platform. It is denoted by type ``gke-k8s-cluster``.

.. code-block:: yaml
---
"foo:bar:production-cluster":
type: gcp-k8s-cluster
type: gke-k8s-cluster
description: My production cluster
cluster:
location: gcp-location
Expand All @@ -207,13 +207,13 @@ A GKE Kubernetes Cluster, hosted in Google Cloud Platform. It is denoted by type
AWS Cluster
^^^^^^^^^^^

An EKS Kubernetes cluster hosted in Amazon Web Services. It is denoted by type ``aws-k8s-cluster``.
An EKS Kubernetes cluster hosted in Amazon Web Services. It is denoted by type ``eks-k8s-cluster``.

.. code-block:: yaml
---
"foo:bar:production-cluster":
type: aws-k8s-cluster
type: eks-k8s-cluster
description: My production cluster
cluster:
name: CLUSTER_NAME
Expand Down
30 changes: 28 additions & 2 deletions docs/source/network/network-configuration-attributes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Used to configure a node
| network | A hash of attributes | yes | If left blank, any Inventories inheriting this configuration will not be |
| | defining a Cloud Provider | | populated with servers unless a Statically defined manifest has been configured|
| | configuration. | | |
| | | | Restricted to nodes of type 'collection', 'inventory', 'gcp-k8s-cluster' and |
| | | | 'aws-k8s-cluster'. |
| | | | Restricted to nodes of type 'collection', 'inventory', 'gke-k8s-cluster' and |
| | | | 'eks-k8s-cluster'. |
| | | | |
| | | | See :ref:`NETWORK_ATTRS`. |
+-----------------------------+-----------------------------+---------------------------------------+--------------------------------------------------------------------------------+
Expand Down Expand Up @@ -65,6 +65,12 @@ Used to configure a node
| | | | Hidden nodes may still be interacted with, but will not appear in the |
| | | | user interface. |
+-----------------------------+-----------------------------+---------------------------------------+--------------------------------------------------------------------------------+
| cluster | A hash of attributes used to| yes | Restricted to nodes of type 'gke-k8s-cluster' and 'eks-k8s-cluster' only. |
| | specify a GKE cluster. | | |
| | | | See :ref:`CLUSTER_ATTRS`. |
+-----------------------------+-----------------------------+---------------------------------------+--------------------------------------------------------------------------------+
|


.. note::

Expand Down Expand Up @@ -150,6 +156,26 @@ AWS specific network attributes
| | ec2. | | |
+-----------------------------+-----------------------------+---------------------------------------+--------------------------------------------------------------------------------+

.. _CLUSTER_ATTRS:

EKS & GKE Cluster Attributes
----------------------------

A hash of attributes uses to populate the top-level ``cluster`` attribute for `eks-k8s-cluster` or `gke-k8s-cluster` nodes.

+-----------------------------+-----------------------------+----------+--------------------------------------------------------------------------------+
| | | | |
| attribute key | description | optional | notes |
+=============================+=============================+==========+================================================================================+
| location | The zone where the cluster | no | GKE nodes only, i.e. nodes of type gke-k8s-cluster. |
| | is located, e.g. | | |
| | europe-west1-c. | | |
+-----------------------------+-----------------------------+----------+--------------------------------------------------------------------------------+
| name | Cluster name. | no | Either GKE or EKS nodes. |
+-----------------------------+-----------------------------+----------+--------------------------------------------------------------------------------+
| account_id | AWS account id. | no | EKS nodes only, i.e. nodes of type eks-k8s-cluster. |
+-----------------------------+-----------------------------+----------+--------------------------------------------------------------------------------+

.. _SSH_ATTRS:

SSH Settings Attributes
Expand Down

0 comments on commit 15f1af5

Please sign in to comment.