External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-27 05:45:02 -02:30
Code Issues Packages Projects Releases Wiki Activity

Regenerate table of contents

Browse Source
This commit is contained in:
Shane McDonald
2019-11-15 14:11:10 -05:00
parent de8c46cab0
commit 0290dd3246
1 changed files with 46 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
INSTALL.md
View File

@@ -4,40 +4,43 @@ This document provides a guide for installing AWX.
## Table of contents ## Table of contents
- [Getting started](#getting-started) - [Installing AWX](#installing-awx)
- [Clone the repo](#clone-the-repo) * [Getting started](#getting-started)
- [AWX branding](#awx-branding) + [Clone the repo](#clone-the-repo)
- [Prerequisites](#prerequisites) + [AWX branding](#awx-branding)
- [System Requirements](#system-requirements) + [Prerequisites](#prerequisites)
- [AWX Tunables](#awx-tunables) + [System Requirements](#system-requirements)
- [Choose a deployment platform](#choose-a-deployment-platform) * [Upgrading from previous versions](#upgrading-from-previous-versions)
- [Official vs Building Images](#official-vs-building-images) + [AWX Tunables](#awx-tunables)
- [OpenShift](#openshift) + [Choose a deployment platform](#choose-a-deployment-platform)
- [Prerequisites](#prerequisites-1) + [Official vs Building Images](#official-vs-building-images)
- [Deploying to Minishift](#deploying-to-minishift) * [OpenShift](#openshift)
- [Pre-build steps](#pre-build-steps) + [Prerequisites](#prerequisites-1)
- [PostgreSQL](#postgresql) + [Pre-install steps](#pre-install-steps)
- [Start the build](#start-the-build) - [Deploying to Minishift](#deploying-to-minishift)
- [Post build](#post-build) - [PostgreSQL](#postgresql)
- [Accessing AWX](#accessing-awx) + [Run the installer](#run-the-installer)
- [Kubernetes](#kubernetes) + [Post-install](#post-install)
- [Prerequisites](#prerequisites-2) + [Accessing AWX](#accessing-awx)
- [Pre-build steps](#pre-build-steps-1) * [Kubernetes](#kubernetes)
- [Configuring Helm](#configuring-helm) + [Prerequisites](#prerequisites-2)
- [Start the build](#start-the-build-1) + [Pre-install steps](#pre-install-steps-1)
- [Accessing AWX](#accessing-awx-1) + [Configuring Helm](#configuring-helm)
- [SSL Termination](#ssl-termination) + [Run the installer](#run-the-installer-1)
- [Docker Compose](#docker-compose) + [Post-install](#post-install-1)
- [Prerequisites](#prerequisites-3) + [Accessing AWX](#accessing-awx-1)
- [Pre-build steps](#pre-build-steps-2) + [SSL Termination](#ssl-termination)
- [Deploying to a remote host](#deploying-to-a-remote-host) * [Docker-Compose](#docker-compose)
- [Inventory variables](#inventory-variables) + [Prerequisites](#prerequisites-3)
+ [Pre-install steps](#pre-install-steps-2)
- [Deploying to a remote host](#deploying-to-a-remote-host)
- [Inventory variables](#inventory-variables)
- [Docker registry](#docker-registry) - [Docker registry](#docker-registry)
- [PostgreSQL](#postgresql-1)
- [Proxy settings](#proxy-settings) - [Proxy settings](#proxy-settings)
- [Start the build](#start-the-build-2) - [PostgreSQL](#postgresql-1)
- [Post build](#post-build-2) + [Run the installer](#run-the-installer-2)
- [Accessing AWX](#accessing-awx-2) + [Post-install](#post-install-2)
+ [Accessing AWX](#accessing-awx-2)
## Getting started ## Getting started
@@ -152,9 +155,9 @@ This can be tuned by overriding the variables found in [/installer/roles/kuberne
For more detail on how resource requests are formed see: [https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources](https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources) For more detail on how resource requests are formed see: [https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources](https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources)
### Pre-build steps ### Pre-install steps
Before starting the build process, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section: Before starting the install, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section:
*openshift_host* *openshift_host*
@@ -218,14 +221,14 @@ If you wish to use an external database, in the inventory file, set the value of
### Run the installer ### Run the installer
To start the build, you will pass two *extra* variables on the command line. The first is *openshift_password*, which is the password for the *openshift_user*, and the second is *docker_registry_password*, which is the password associated with *docker_registry_username*. To start the install, you will pass two *extra* variables on the command line. The first is *openshift_password*, which is the password for the *openshift_user*, and the second is *docker_registry_password*, which is the password associated with *docker_registry_username*.
If you're using the OpenShift internal registry, then you'll pass an access token for the *docker_registry_password* value, rather than a password. The `oc whoami -t` command will generate the required token, as long as you're logged into the cluster via `oc cluster login`. If you're using the OpenShift internal registry, then you'll pass an access token for the *docker_registry_password* value, rather than a password. The `oc whoami -t` command will generate the required token, as long as you're logged into the cluster via `oc cluster login`.
To start the build and deployment, run the following (docker_registry_password is optional if using official images): Run the following command (docker_registry_password is optional if using official images):
```bash ```bash
# Start the build and deployment # Start the install
$ ansible-playbook -i inventory install.yml -e openshift_password=developer -e docker_registry_password=$(oc whoami -t) $ ansible-playbook -i inventory install.yml -e openshift_password=developer -e docker_registry_password=$(oc whoami -t)
``` ```
@@ -346,9 +349,9 @@ This can be tuned by overriding the variables found in [/installer/roles/kuberne
For more detail on how resource requests are formed see: [https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/) For more detail on how resource requests are formed see: [https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/)
### Pre-build steps ### Pre-install steps
Before starting the build process, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section uncommenting when necessary. Make sure the openshift and standalone docker sections are commented out: Before starting the install process, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section uncommenting when necessary. Make sure the openshift and standalone docker sections are commented out:
*kubernetes_context* *kubernetes_context*
@@ -424,7 +427,7 @@ Unlike Openshift's `Route` the Kubernetes `Ingress` doesn't yet handle SSL termi
+ This also installs the `docker` Python module, which is incompatible with `docker-py`. If you have previously installed `docker-py`, please uninstall it. + This also installs the `docker` Python module, which is incompatible with `docker-py`. If you have previously installed `docker-py`, please uninstall it.
- [Docker Compose](https://docs.docker.com/compose/install/). - [Docker Compose](https://docs.docker.com/compose/install/).
### Pre-build steps ### Pre-install steps
#### Deploying to a remote host #### Deploying to a remote host
@@ -455,7 +458,7 @@ If you choose to use the official images then the remote host will be the one to
#### Inventory variables #### Inventory variables
Before starting the build process, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section: Before starting the install process, review the [inventory](./installer/inventory) file, and uncomment and provide values for the following variables found in the `[all:vars]` section:
*postgres_data_dir* *postgres_data_dir*
@@ -532,7 +535,7 @@ If you wish to use an external database, in the inventory file, set the value of
### Run the installer ### Run the installer
If you are not pushing images to a Docker registry, start the build by running the following: If you are not pushing images to a Docker registry, start the install by running the following:
```bash ```bash
# Set the working directory to installer # Set the working directory to installer