diff --git a/docs/assets/gui_ansible.png b/docs/assets/gui_ansible.png new file mode 100644 index 0000000..087e9b8 Binary files /dev/null and b/docs/assets/gui_ansible.png differ diff --git a/docs/assets/gui_navigation.png b/docs/assets/gui_navigation.png new file mode 100644 index 0000000..307268d Binary files /dev/null and b/docs/assets/gui_navigation.png differ diff --git a/docs/gui.md b/docs/gui.md index 15f5812..b2bba0e 100644 --- a/docs/gui.md +++ b/docs/gui.md @@ -1 +1,36 @@ # Usage with GUI + +We have simple UI available at . + +## Navigation + +For navigation you can use the navigation bar on the top left. + +![navigation](./assets/gui_navigation.png) + +### Home + +Currently nothing to see here. The goal is to display some +general information here. Link to documentation and important +news etc. + +### Ansible + +Here you can load your forge configuration file from the data store, +clone a project and build the container image. The buttons should be self explanatory. +The "Deploy VM" button is currently a mock-up, sorry :wink: +we are [working](https://github.com/ublue-os/forge/issues/35) on it. + +![ansible](./assets/gui_ansible.png) + +### Registry + +Currently nothing to see here. The goal is to display some +information about the docker registry here. +Like a list of all available images you have uploaded etc. + +### About + +Currently nothing to see here. The goal is to display some +information here about the software and versions used in this project +and maybe some acknowledgments etc. diff --git a/docs/index.md b/docs/index.md index 4ccdb78..6f3fd69 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Universal Blue - Forge -On-premises Universal Blue. This repository is intended to provide the service units +On-premises Universal Blue. This projects provides the service units necessary to set up a self-hosted OS forge for custom images. ## Configuration diff --git a/docs/variables.md b/docs/variables.md index d415114..be982ea 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -10,14 +10,14 @@ The following configuration variables are available and can be set to your likin -| Name | Type | Default value | Description | -| ---------------------------------- | ---- | ------------------------------------------------- | ---------------------------------------------------------------- | -| `forge_git_repository_url` | str | | Git repository url | -| `forge_git_repository_destination` | str | `{{ forge_data_volume_mountpoint }}`/data/bluefin | Git destination where repository is cloned to.
**_Note:_** | -| `forge_git_repository_version` | str | main | Git repository branch or tag or commit version | -| `forge_registry_url` | str | registry.ublue.local | Container registry url | +| Name | Type | Default value | Description | +| ---------------------------------- | ---- | ------------------------------------------------- | ---------------------------------------------- | +| `forge_git_repository_url` | str | | Git repository url | +| `forge_git_repository_destination` | str | `{{ forge_data_volume_mountpoint }}`/data/bluefin | Git destination where repository is cloned to. | +| `forge_git_repository_version` | str | main | Git repository branch or tag or commit version | +| `forge_registry_url` | str | registry.ublue.local | Container registry url | - + -On playbook launch your variable file will be imported into the ansible container so that -the settings are available during playbook execution. +**_Note:_** The `{{ forge_data_volume_mountpoint }}` points to your ublue-os_forge-data +podman volume.