Skip to content

Commit

Permalink
wip - more docs (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
tepene committed May 10, 2024
1 parent 6cdf77b commit cbf3c0c
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 10 deletions.
Binary file added docs/assets/gui_ansible.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gui_navigation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions docs/gui.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# Usage with GUI

We have simple UI available at <https://forge.ublue.local>.

## 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 <registry.ublue.local> 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.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
18 changes: 9 additions & 9 deletions docs/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The following configuration variables are available and can be set to your likin

<!-- markdownlint-disable MD013 -->

| Name | Type | Default value | Description |
| ---------------------------------- | ---- | ------------------------------------------------- | ---------------------------------------------------------------- |
| `forge_git_repository_url` | str | <https://github.com/ublue-os/bluefin.git> | Git repository url |
| `forge_git_repository_destination` | str | `{{ forge_data_volume_mountpoint }}`/data/bluefin | Git destination where repository is cloned to. </br> **_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 | <https://github.com/ublue-os/bluefin.git> | 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 |

<!-- markdownlint-enable MD013 -->
<!-- markdownlint-enable MD013-->

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.

0 comments on commit cbf3c0c

Please sign in to comment.