Skip to content
Open
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
3 changes: 3 additions & 0 deletions docs/apiref.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
API Reference
=============

In case you'd like to use some functionality of osia, or extend its behaviour, here is all
of the code documentation for use.

.. toctree::

source/modules
6 changes: 1 addition & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
.. osia documentation master file, created by
sphinx-quickstart on Sat Apr 11 15:39:06 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to osia's documentation!
================================

Expand All @@ -11,6 +6,7 @@ Welcome to osia's documentation!
:caption: Contents:

installation
userGuide/index
usage/index
apiref

Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Installation
============

In order to successfully install this program and run it you need folowing dependencies:
In order to successfully install this program and run it you need following dependencies:

* `python3` and `pip`
* `git` for the management of installation files
Expand All @@ -17,7 +17,7 @@ $ pip install tbd

## Docker image

As of version `v0.1.4`, there are also docker images available in `quay.io`.
As of version `v0.1.7`, there are also docker images available in `quay.io`.
The images are stored in repository called _tbd_ and there are always two images per release

* `osia-ubi7` docker image based on top of Universal Base Image for rhel 7
Expand Down
12 changes: 12 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Quickstart
==========

To start with `osia` you need a few following things.

* Git repository with some upstream (like github).
* Credentials for cloud provider (openstack, aws).
* Python 3 and pip.

The most simple scenario for quickstart is installation into AWS.

*
3 changes: 3 additions & 0 deletions docs/usage/clean.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Clean
=====

Here follows full documentation of clean subcommand of osia. Same output
can be achieved by running ``osia clean --help``.

.. argparse::
:module: osia.cli
:func: _setup_parser
Expand Down
3 changes: 3 additions & 0 deletions docs/usage/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
CLI Reference
=============

This section shows full help for commands and options of osia's execution.
In order to understand the settings please follow parts of :doc:`../userGuide/index`.

.. toctree::
install
clean
Empty file added docs/userGuide/aws.md
Empty file.
Empty file added docs/userGuide/clean.md
Empty file.
14 changes: 14 additions & 0 deletions docs/userGuide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _userGuide:
User Guide
==========

This guide will walk you through the basic scenarios of usage
in order to install the openshift into selected
.. toctree::
:maxdepth: 2
:caption: Contents:

setup
openstack
aws
clean
Empty file added docs/userGuide/openstack.md
Empty file.
22 changes: 22 additions & 0 deletions docs/userGuide/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Setup guide

The main aim of osia, is to support automation necessary for quick deployment and destruction of clusters usable
especially in CI process. That's why osia tool leverages the Git VCS to store all of the artifacts created by the
OpenShift installation. Osia tool therefore expects the git repository as the place where it is started, and where all
of the service files will be persisted.

In order to start you should create git repository by simple running

```
mkdir my_clusters
git init
```

By those steps you will have a git repository ready for your usage.
The next necessary step would be to setup the remote tracking repository.


## Configuration file

The configuration file is in format of `yaml` and it is expected to hold default
values for install