Skip to content

Commit

Permalink
Improved nodes doc
Browse files Browse the repository at this point in the history
  • Loading branch information
guillaume authored and guillaume committed Nov 8, 2022
1 parent 88aa6d5 commit edcfeba
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/core-concepts/nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
Nodes
*****

Introduction
============

A node is an object that represents a resource within Bcome. It can be navigated to using the CLI, or it can be interacted with programmatically.

Exposed onto any node object - whether reached via CLI navigation, directly through keyed-access, or in custom code from a Registry script - are the methods provided by the framework (provided by the menu) and any custom tasks added by you in your framework implementation (see :doc:`../registry/overview`).
Expand All @@ -17,6 +20,9 @@ Your installation's architecture - its interface - is determined directly by how

If you don't have a networks.yml file yet, you will need to initialize your project. See: :doc:`../getting-started/setting-up-your-project`.

Declaring Nodes
===============

Nodes in your networks.yml configuration are declared via YAML (see: :doc:`../network/network-configuration-attributes`) in the following format:

.. code-block:: yaml
Expand All @@ -43,6 +49,10 @@ Nodes are laid out in a parent - child format, for example:
description: "The child"
type: inventory
Any networking configuration declared in a parent node in the networks.yml configuration will be inherited by any child node, unless expressly overidden in the child. This allows children to inherit networking configuraton from their parent (e.g. a GCP authorisation) but override where appropriate (e.g. a location or region). For more information, see :doc:`../network/network-configuration-attributes`).

Any metadata declared in a parent node will in inherited (i.e. available) to any child node, unless expressly overidden in the metadata for that child. For more information, see :doc:`../metadata/metadata-framework`.

.. note::

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

0 comments on commit edcfeba

Please sign in to comment.