porthole/README.md
Michael Beaver a8ac95ca66 Replace OSH-AIO instructions and add links
Currently the docs here have the instructions from the Openstack-Helm
All-in-One environment docs instead of just linking to the docs
themselves. This change removes the redundant instructions and replaces
them with a link to the source of the instructions. This also adds a
link to the Airship in a Bottle instructions to the postgresql-utility
docs.

This is beneficial both to reduce the documentation here, as well as
avoiding changes to the original documents not making their way here.

Change-Id: I54af601112f93d9b50653afb56b93d0cd253658e
2020-03-05 19:17:07 +00:00

65 lines
1.8 KiB
Markdown

# Utility Containers
Utility containers give Operations staff an interface to an Airship
environment that enables them to perform routine operations and
troubleshooting activities. Utility containers support Airship
environments without exposing secrets and credentials while at
the same time restricting access to the actual containers.
## Prerequisites
=======
Deploy OSH-AIO.
=======
Deploy the Openstack-Helm All-in-One environment starting from
[here](https://docs.openstack.org/openstack-helm/latest/install/common-requirements.html)
up through the section `Deploy Compute Kit`
The recommended minimum system requirements for a full deployment are:
* 16 GB RAM
* 8 Cores
* 48 GB HDD
=======
1. To run further commands from the CLI manually, execute the following
to set up authentication credentials
export OS_CLOUD=openstack_helm
2. Clone the Porthole repo to openstack-helm project
git clone https://opendev.org/airship/porthole.git
## To deploy utility pods
1. To Deploy Utility containers, Please run required scripts
cd porthole
2. Deploy `Ceph-utility`.
./tools/deployment/utilities/010-ceph-utility.sh
3. Deploy `Compute-utility`.
./tools/deployment/utilities/020-compute-utility.sh
4. Deploy `Etcdctl-utility`.
./tools/deployment/utilities/030-etcdctl-utility.sh
5. Deploy `Mysqlclient-utility`.
./tools/deployment/utilities/040-Mysqlclient-utility.sh
6. Deploy `Openstack-utility`.
./tools/deployment/utilities/050-openstack-utility.sh
## NOTE
The PostgreSQL utility container is deployed as a part of Airship-in-a-Bottle (AIAB).
To deploy and test `postgresql-utility`, see the
[PostgreSQL README](https://opendev.org/airship/porthole/src/branch/master/images/postgresql-utility/README.md).