Skip to content

Commit

Permalink
more updates
Browse files Browse the repository at this point in the history
  • Loading branch information
webzakimbo committed Jan 20, 2023
1 parent 35155df commit fc9f924
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/source/getting-started/create-project-structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ See :doc:`../core-concepts/network-configuration` and :doc:`../core-concepts/nod
Configure your cloud authorizations
===================================

To populate your installation with servers from a cloud provider you will need to add an authorization.
To populate your installation with servers or load in a Kubernetes cluster you will need to add an authorization.

An authorization may be associated with more than one node, whilst you may add as many different authorizations as you like to your installation.
An authorization may be associated with more than one node, whilst you may add as many different authorizations as you like to your installation, adding as many different AWS or GCP accounts to your project as yyou like.

When you interact with a Bcome node configured for an authorisation, the framework will authenticate you against the cloud provider in question so that it may retrieve a server list, which it will then use to populate your Inventory.
When you interact with a Bcome node configured for an authorisation, the framework will authenticate you against the cloud provider in question so that it may retrieve resources.

To add an AWS authorization. See: :doc:`prepare-aws-access`.

Expand All @@ -56,7 +56,7 @@ Setup your SSH pathways

If you're not solely interacting with containers, then configuring :doc:`../core-concepts/ssh` is core to Bcome.

If your server instances are not directly accessible you will need to configure your SSH pathways so that Bcome knows how to navigate the proxies you have in place.
If your server instances are not directly accessible you will need to configure your SSH pathways so that Bcome knows how to navigate the proxies you have in place. Your SSH pathways will instruct Bcome as to how to proxy its connections allowing it to access your servers.

This is done by adding to your networks.yml configuration file.

Expand All @@ -66,9 +66,9 @@ For configuration details, please refer to the |SSH_SETTINGS_ATTRS|_ documentati
The Registry & Orchestration
============================

The in-built Registry framework is what makes Bcome your DevOps Console.
The in-built Registry framework lets you add re-usable orchestration onto your nodes.

It will allow you to associate and re-use custom tasks - i.e. custom orchestration - with your nodes.
It will allow you to define and re-use custom orchestration tasks that can be used to interact with the nodes - your servers, clusters, containers, or ad-hoc kubernetes resources - in your installation.

See :doc:`../registry/overview` and :doc:`../registry/registry-examples` for more information. Our |GUIDES|_ site also has example configuration.

39 changes: 39 additions & 0 deletions docs/source/usage/executing-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,51 @@ Given command 'foo' available to node parent:child:grandchild, how would you inv
> bcome child:grandchild
> foo
OR

.. code-block:: bash
> bcome
> cd child:grandchild
> foo
OR

.. code-block:: bash
> bcome
> cd child
> cd grandchild
> foo
OR, using dot-notation

.. code-block:: bash
> bcome
> child.granchild.foo
OR, a dot-notation example passing in parameters, for e.g. ``run``:

.. code-block:: bash
> bcome
> child.grandchild.run "ls -al"
.. note::

When you an enter an IRB session, you are in the scope of an instance of a Ruby object (see: :doc:`../core-concepts/node`).

Bcome's Console assigns an instance of your node as this session object.

Invoking a command in the console using dot notation
----------------------------------------------------






Invoking commands with Keyed-access
-----------------------------------
Expand Down

0 comments on commit fc9f924

Please sign in to comment.