diff --git a/docs/guides/operations-guide/manager/facts.md b/docs/guides/operations-guide/manager/facts.md new file mode 100644 index 0000000000..5a521792b9 --- /dev/null +++ b/docs/guides/operations-guide/manager/facts.md @@ -0,0 +1,17 @@ +--- +sidebar_label: Facts +--- + +# Facts + +TODOs: + +- What exactly is this step responsible for and what purpose does it serve? +- When should this task to executed? +- What is the technical background? +.... + +``` +osism apply facts +``` + diff --git a/docs/guides/operations-guide/manager/images/python-osism.drawio.png b/docs/guides/operations-guide/manager/images/python-osism.drawio.png index 7772f1484e..3e8cc65eec 100644 Binary files a/docs/guides/operations-guide/manager/images/python-osism.drawio.png and b/docs/guides/operations-guide/manager/images/python-osism.drawio.png differ diff --git a/docs/guides/operations-guide/manager/index.md b/docs/guides/operations-guide/manager/index.md index f0d94e6288..f4a93533cf 100644 --- a/docs/guides/operations-guide/manager/index.md +++ b/docs/guides/operations-guide/manager/index.md @@ -5,4 +5,35 @@ sidebar_position: 10 # Manager +## Architecture View + +As you can easily guess from the name "manager", this is responsible for managing an entire OSISM installation. +The following diagram provides an overview of the components involved. + ![OSISM orchestrator](./images/python-osism.drawio.png) + +## OSISM Usage + +### Get help for OSISM commands + +``` +osism help +osism help apply +``` + +### Update the configuration + +Once the manager has been deployed and the configuration repository has been initially transferred to the manager node, +the configuration repository can be updated using osism apply configuration. + +Configuration changes are typically staged in a clone of the configuration repo to have versioning of changes. + +``` +cd /opt/configuration +git pull +osism apply configuration +``` + +:::warning +If local changes were made directly in the configuration repository on the manager node, these are overwritten without asking. +::: diff --git a/docs/guides/operations-guide/manager/reconciler.md b/docs/guides/operations-guide/manager/reconciler.md new file mode 100644 index 0000000000..b3b1447698 --- /dev/null +++ b/docs/guides/operations-guide/manager/reconciler.md @@ -0,0 +1,21 @@ +--- +sidebar_label: Reconciler +--- + +# Reconciler + +TODOs: + +- What exactly is this step responsible for and what purpose does it serve? +- When should this task to executed? +- What is the technical background? +.... + +### Rebuild the internal inventory + +Invoke the [inventory reconciliation](../../configuration-guide/inventory.md#reconciler). + +``` +osism reconciler sync +``` +