Skip to content

Add documentation for OpenStack tools #319

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.

Sign up for GitHub

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

Open
nicolasbock wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for OpenStack tools #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/.custom_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Leave a blank line at the end of this file to support concatenation
apache
AthenaV2
az
backend
backends
balancers
Caracal
ceph
Charmcraft
Expand All @@ -12,9 +14,11 @@ config
configs
cryptographically
DHSS
distributable
dvipng
fonts
freefont
functest
github
GPG
gyre
Expand All @@ -25,6 +29,7 @@ IDP
IDPs
Intersphinx
io
ipv
JDK
Jira
Kanban
Expand All @@ -33,16 +38,20 @@ Keycloak
lang
LaTeX
latexmk
lnav
manila
Manila
microceph
Multipass
neutronclient
octavia
oidc
openidc
OpenIDC
openstack
openstackclient
openstackclients
OSCI
otf
plantuml
PNG
Expand All @@ -52,10 +61,14 @@ Pygments
QEMU
readthedocs
Rockcraft
routable
rst
rsync
samltestid
sg
sitemapindex
sos
ssl
SSL
stsstack
STSStack
Expand All @@ -73,6 +86,8 @@ uncommenting
URIs
url
utils
vips
vm
VMs
WCAG
webhook
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@

# myst_enable_extensions = set()

# myst_heading_anchors = 3

# Custom Sphinx extensions; see
# https://www.sphinx-doc.org/en/master/usage/extensions/index.html
Expand Down
13 changes: 6 additions & 7 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ STSStack-Bundles Documentation

STSStack-Bundles is a set of bundles that leverage Juju bundle overlays to allow generating complex deployments from a number of options using a single command. These bundles are designed for use with the Juju OpenStack provider.

The top level directory contains a set of modules, each of which has a generate-bundle.sh script which you can use to create a deployment from a number of options.
The top level directory contains a set of modules, each of which has a ``generate-bundle.sh`` script which you can use to create a deployment from a number of options.

NOTE: see generate-bundle.sh --help for option info about using that particular module.
NOTE: see :doc:`user-docs/generate-bundle` ``--help`` for option info about using that particular module.

Basic usage:

* give your deployment a name with (--name)
* give your deployment a name with (``--name``)
* create a Juju model using the given name or use existing one
* add one or more feature overlays depending on what you need (see --list-overlays)
* resources are stored under a named directory so as to be able to avoid collisions and replay later (--replay)
* immediate deploy (--run) or save for later
* add one or more feature overlays depending on what you need (see ``--list-overlays``)
* resources are stored under a named directory so as to be able to avoid collisions and replay later (``--replay``)
* immediate deploy (``--run``) or save for later


.. toctree::
Expand All @@ -39,4 +39,3 @@ In this documentation
:link-type: doc

**For contributors** - how to contribute to STSStack-Bundles.

29 changes: 29 additions & 0 deletions docs/user-docs/generate-bundle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
generate-bundle.sh
Copy link
Copy Markdown
Member

@dosaboy dosaboy Oct 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The information on this page already exists on the "Usage" page, rather than have a new page just for this script maybe better to update the existing info to cover anything extra added here and then reference the Usage page in your Tools page?

==================

The `generate-bundle.sh` script is used to create a bundle, and optionally deploy it, of a Charmed OpenStack, Kubernetes, or Ceph deployment.

Usage
-----

Run the script from the project root:

.. code::

./generate-bundle.sh

This will generate the necessary files for deployment in the `b` directory.

Options
-------

You can pass additional options to customise the build process. For example:

.. code::

./generate-bundle.sh --keystone-ha --num-compute 2 --run

Prerequisites
-------------

Make sure you have all required dependencies installed before running the script.
1 change: 1 addition & 0 deletions docs/user-docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ User Documentation
:maxdepth: 2

usage
generate-bundle.sh<generate-bundle>
openstack/index
ceph/index
osm/index
Expand Down
6 changes: 6 additions & 0 deletions docs/user-docs/openstack/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ OVN <ovn>
SAML <saml>
Keystone + OpenIDC <keystone-openidc>
Manila <manila-generic>
Tools <tools>
```

````{grid} 1 1 2 2
Expand Down Expand Up @@ -89,4 +90,9 @@ Dynamic Routing
:link-type: doc
**Tutorial** - learn how to deploy an OpenStack cloud on `serverstack`
```
```{grid-item-card} Tools
:link: tools
:link-type: doc
**Tools** - OpenStack Tools
```
````
Loading
Loading