From eab74b8200fd7af0e496ec3a472c3d7e1a9dbe53 Mon Sep 17 00:00:00 2001 From: James Read <contact@jread.com> Date: Tue, 25 Feb 2020 16:06:40 +0100 Subject: [PATCH] Publish docs/*.adoc's into into GitHub pages pretty HTML (#1181) --- docs/Preparing_your_workstation.adoc | 31 +++++++++++++++---------------- 1 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/Preparing_your_workstation.adoc b/docs/Preparing_your_workstation.adoc index 78549af..ab9898e 100644 --- a/docs/Preparing_your_workstation.adoc +++ b/docs/Preparing_your_workstation.adoc @@ -1,22 +1,21 @@ + :toc2: -= Preparing your Workstation to use the Ansible Playbooks +== Preparing your Workstation to use Ansible Playbooks - - -== Less prerequisites: Dockerfiles +=== Less prerequisites: Dockerfiles It is possible to run agnosticd with docker. This way you don't have to install anything (except Docker). If you want to use docker to deploy, look at the link:../tools/builds[tools/builds] Readme. -== Less prerequistes: python virtualenvs +=== Less prerequistes: python virtualenvs It is now encouraged to use python virtualenvs to develop from your laptop. Please have a look at link:../tools/virtualenvs[tools/virtualenvs]. -=== OSP cloud-provider +==== OSP cloud-provider .In your home directory ---- @@ -45,10 +44,10 @@ (openstack-ansible-2.9) $ pip install -r https://raw.githubusercontent.com/redhat-cop/agnosticd/development/tools/virtualenvs/openstack-ansible-latest.txt ---- -== Prerequisites +=== Prerequisites In order to use these playbooks, you will need to set a few things up. -== Software Requirements on workstation +=== Workstation dependencies * Some deployments would require a Red Hat Customer Portal account that has appropriate subscriptions. This is not required for the playbook themselves. @@ -56,7 +55,7 @@ NOTE: Red Hat employee subscriptions can be used -=== Software required for deployment +==== Software required for deployment * https://www.python.org[Python] * http://docs.pythonboto.org[Python Boto] version 2.41 or greater @@ -131,9 +130,9 @@ ---- -== Configuring your workstation +=== Configuring your workstation -=== Configure the EC2 Credentials +==== Configure the EC2 Credentials * You will need to place your EC2 credentials in the ~/.aws/credentials file: [source, shell] @@ -200,7 +199,7 @@ NOTE: Finer-grained permissions are possible, and pull requests are welcome. -=== AWS existing resources +==== AWS existing resources * A route53 link:http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingHostedZone.html[public hosted zone] @@ -235,7 +234,7 @@ done ---- -== OpenStack +=== OpenStack ---- # Install python modules needed by ansible @@ -247,7 +246,7 @@ NOTE: on Fedora `dnf install python3-openstacksdk python3-openstackclient python-openstackclient-doc python-openstackclient-lang python3-heatclient python-heatclient-doc python3-dns` will do the job (you may choose to skip doc and lang packages). -=== Azure +==== Azure If you want to deploy on azure you will need the Azure client. @@ -284,7 +283,7 @@ NOTE: `--force` is used here, because of a known link:https://github.com/ansible/ansible/issues/38894[issue]. -==== Service principal +===== Service principal It's better to use a service principal instead of your main credentials. Refer to the https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli?view=azure-cli-latest[official documentation]. @@ -305,7 +304,7 @@ ---- -=== Virtualenv +==== Virtualenv If you want to use virtualenv, you can try & adapt this: -- Gitblit v1.9.3