Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] general description, improve general understanding #639

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/guides/operations-guide/manager/facts.md
Original file line number Diff line number Diff line change
@@ -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
```

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/guides/operations-guide/manager/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
21 changes: 21 additions & 0 deletions docs/guides/operations-guide/manager/reconciler.md
Original file line number Diff line number Diff line change
@@ -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
```

Loading