https://github.com/magenta-aps/os2mo-init
https://github.com/magenta-aps/os2mo-init
managed-by-atlantis mirrored-repository
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/magenta-aps/os2mo-init
- Owner: magenta-aps
- Created: 2022-12-08T14:26:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T17:32:22.000Z (8 months ago)
- Last Synced: 2024-12-26T16:11:23.092Z (6 months ago)
- Topics: managed-by-atlantis, mirrored-repository
- Language: Python
- Homepage:
- Size: 380 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSES/MPL-2.0.txt
Awesome Lists containing this project
README
# OS2mo Init
## Usage
The primary usage of the tool is to initialise OS2mo's database with a root organisation, all required classes,
recommended facets, and IT systems. For development, most users will probably want to use Docker Compose as follows:
```yaml
services:
mo-init:
image: magentaaps/os2mo-init:latest
environment:
MO_URL: "http://mo:5000"
AUTH_SERVER: "http://keycloak:8080/auth"
AUTH_REALM: "mo"
CLIENT_ID: "dipex"
CLIENT_SECRET: "603f1c82-d012-4d04-9382-dbe659c533fb"
depends_on:
mo:
condition: service_healthy
```
Which will initialise a minimal MO instance using the default configuration file `config.default.yml`. Modifying the
configuration is as easy as copying the default `config.default.yml` from here to `init.config.yml` in your repo and
extending Docker Compose as follows:
```yaml
services:
mo-init:
volumes:
- type: bind
source: ./init.config.yml
target: /config/config.yml
read_only: true
```
Ad-hoc usage can be done as follows:
```bash
docker run --rm --mount type=bind,source="$(pwd)"/init.config.yml,destination=/config/config.yml --network=host -e MO_URL='http://localhost:5000' -e CLIENT_ID='dipex' -e CLIENT_SECRET='603f1c82-d012-4d04-9382-dbe659c533fb' -e AUTH_SERVER='http://localhost:5000/auth' -e AUTH_REALM='mo' magentaaps/os2mo-init:latest
```
Optionally with the `--network=host` or `--network=os2mo_default` docker flag.
## Deployment
Initialisation setup is configured using a configuration file; `/config/config.yml` by default. The provided Docker
image copies the default configuration [config.default.yml](config.default.yml) to this location in the image, which
sets up a minimal MO instance.
To modify the configuration in a Kubernetes cluster, first define a `ConfigMap` as follows:
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: os2mo-init-config
data:
config: |
root_organisation:
...
facets:
...
```
Then connect it to the deployment or pod:
```yaml
spec:
containers:
- name: mo-init
image: magentaaps/os2mo-init:latest
volumeMounts:
- name: os2mo-init-config-volume
mountPath: /config
readOnly: true
volumes:
- name: os2mo-init-config-volume
configMap:
name: os2mo-init-config
items:
- key: config
path: config.yml
```
## Build
```commandline
docker build . -t os2mo-init
```
Which yields:
```text
...
Successfully built ...
Successfully tagged os2mo-init:latest
```
After which you can run:
```commandline
docker run --rm os2mo-init:latest --help
```
## Versioning
This project uses [Semantic Versioning](https://semver.org/) with the following strategy:
- MAJOR: Incompatible changes to existing commandline interface.
- MINOR: Backwards compatible updates to commandline interface.
- PATCH: Backwards compatible bug fixes.
## Authors
Magenta ApS
## License
- This project: [MPL-2.0](LICENSES/MPL-2.0.txt)
This project uses [REUSE](https://reuse.software) for licensing. All licenses can be found in the [LICENSES folder](LICENSES/) of the project.