Skip to content

Commit d333b00

Browse files
committed
Redirect documentation to awx-operator docs
1 parent 42dbd4e commit d333b00

File tree

1 file changed

+1
-107
lines changed

1 file changed

+1
-107
lines changed

INSTALL.md

+1-107
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@ Table of Contents
33

44
* [Installing AWX](#installing-awx)
55
* [The AWX Operator](#the-awx-operator)
6-
* [Quickstart with minikube](#quickstart-with-minikube)
7-
* [Starting minikube](#starting-minikube)
8-
* [Deploying the AWX Operator](#deploying-the-awx-operator)
9-
* [Verifying the Operator Deployment](#verifying-the-operator-deployment)
10-
* [Deploy AWX](#deploy-awx)
11-
* [Accessing AWX](#accessing-awx)
126
* [Installing the AWX CLI](#installing-the-awx-cli)
137
* [Building the CLI Documentation](#building-the-cli-documentation)
148

@@ -22,110 +16,10 @@ If you're attempting to migrate an older Docker-based AWX installation, see: [Mi
2216

2317
## The AWX Operator
2418

25-
Starting in version 18.0, the [AWX Operator](https://github.com/ansible/awx-operator) is the preferred way to install AWX.
19+
Starting in version 18.0, the [AWX Operator](https://github.com/ansible/awx-operator) is the preferred way to install AWX. Please refer to the [AWX Operator](https://github.com/ansible/awx-operator) documentation.
2620

2721
AWX can also alternatively be installed and [run in Docker](./tools/docker-compose/README.md), but this install path is only recommended for development/test-oriented deployments, and has no official published release.
2822

29-
### Quickstart with minikube
30-
31-
If you don't have an existing OpenShift or Kubernetes cluster, minikube is a fast and easy way to get up and running.
32-
33-
To install minikube, follow the steps in their [documentation](https://minikube.sigs.k8s.io/docs/start/).
34-
35-
:warning: NOTE |
36-
--- |
37-
If you're about to install minikube or have already installed it, please be sure you're using [Minikube v1.18.1](https://github.com/kubernetes/minikube/releases/tag/v1.18.1). There's a [bug](https://github.com/ansible/awx-operator/issues/205) right now that will not allow you to run it using Minikube v1.19.x.
38-
#### Starting minikube
39-
40-
Once you have installed minikube, run the following command to start it. You may wish to customize these options.
41-
42-
```
43-
$ minikube start --cpus=4 --memory=8g --addons=ingress
44-
```
45-
46-
#### Deploying the AWX Operator
47-
48-
For a comprehensive overview of features, see [README.md](https://github.com/ansible/awx-operator/blob/devel/README.md) in the awx-operator repo. The following steps are the bare minimum to get AWX up and running.
49-
50-
Start by going to https://github.com/ansible/awx-operator/releases and making note of the latest release. Replace `<tag>` in the URL below with the version you are deploying:
51-
52-
```
53-
$ minikube kubectl -- apply -f https://raw.githubusercontent.com/ansible/awx-operator/<tag>/deploy/awx-operator.yaml
54-
```
55-
56-
##### Verifying the Operator Deployment
57-
58-
After a few seconds, the operator should be up and running. Verify it by running the following command:
59-
60-
```
61-
$ minikube kubectl get pods
62-
NAME READY STATUS RESTARTS AGE
63-
awx-operator-7c78bfbfd-xb6th 1/1 Running 0 11s
64-
```
65-
66-
#### Deploy AWX
67-
68-
Once the Operator is running, you can now deploy AWX by creating a simple YAML file:
69-
70-
```
71-
$ cat myawx.yml
72-
---
73-
apiVersion: awx.ansible.com/v1beta1
74-
kind: AWX
75-
metadata:
76-
name: awx
77-
spec:
78-
tower_ingress_type: Ingress
79-
```
80-
81-
> If a custom AWX image is needed, see [these docs](./docs/build_awx_image.md) on how to build and use it.
82-
83-
And then creating the AWX object in the Kubernetes API:
84-
85-
```
86-
$ minikube kubectl apply -- -f myawx.yml
87-
awx.awx.ansible.com/awx created
88-
```
89-
90-
After creating the AWX object in the Kubernetes API, the operator will begin running its reconciliation loop.
91-
92-
To see what's going on, you can tail the logs of the operator pod (note that your pod name will be different):
93-
94-
```
95-
$ minikube kubectl logs -- -f awx-operator-7c78bfbfd-xb6th
96-
```
97-
98-
After a few seconds, you will see the database and application pods show up. On a fresh system, it may take a few minutes for the container images to download.
99-
100-
```
101-
$ minikube kubectl get pods
102-
NAME READY STATUS RESTARTS AGE
103-
awx-5ffbfd489c-bvtvf 3/3 Running 0 2m54s
104-
awx-operator-7c78bfbfd-xb6th 1/1 Running 0 6m42s
105-
awx-postgres-0 1/1 Running 0 2m58s
106-
```
107-
108-
##### Accessing AWX
109-
110-
To access the AWX UI, you'll need to grab the service url from minikube:
111-
112-
```
113-
$ minikube service awx-service --url
114-
http://192.168.59.2:31868
115-
```
116-
117-
On fresh installs, you will see the "AWX is currently upgrading." page until database migrations finish.
118-
119-
Once you are redirected to the login screen, you can now log in by obtaining the generated admin password (note: do not copy the trailing `%`):
120-
121-
```
122-
$ minikube kubectl -- get secret awx-admin-password -o jsonpath='{.data.password}' | base64 --decode
123-
b6ChwVmqEiAsil2KSpH4xGaZPeZvWnWj%
124-
```
125-
126-
Now you can log in at the URL above with the username "admin" and the password above. Happy Automating!
127-
128-
12923
# Installing the AWX CLI
13024

13125
`awx` is the official command-line client for AWX. It:

0 commit comments

Comments
 (0)