[collection] Remove instance defaults from docs (#12964)

We don't specify defaults in the module (because it messes up Instance
updates because AWX things we are trying to change things to be the
default).

- Update the docs to remove the defaults that no longer exist
- Update tests to make them pass (oops)
- Fix tangentially related typo in Kind development docs

Signed-off-by: Rick Elrod <rick@elrod.me>
This commit is contained in:
Rick Elrod 2022-09-27 15:18:38 -05:00 committed by GitHub
parent ca46aec483
commit 42109fb45a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 8 deletions

View File

@ -37,12 +37,10 @@ options:
- If true, the instance will be enabled and used.
required: False
type: bool
default: True
managed_by_policy:
description:
- Managed by policy
required: False
default: True
type: bool
node_type:
description:
@ -51,7 +49,6 @@ options:
- execution
required: False
type: str
default: execution
node_state:
description:
- Indicates the current life cycle stage of this instance.
@ -59,13 +56,11 @@ options:
- deprovisioning
- installed
required: False
default: installed
type: str
listener_port:
description:
- Port that Receptor will listen for incoming connections on.
required: False
default: 27199
type: int
extends_documentation_fragment: awx.awx.auth
'''

View File

@ -14,6 +14,8 @@
- name: Create an instance
awx.awx.instance:
hostname: "{{ item }}"
node_type: execution
node_state: installed
with_items:
- "{{ hostname1 }}"
- "{{ hostname2 }}"
@ -26,6 +28,8 @@
- name: Create an instance with non-default config
awx.awx.instance:
hostname: "{{ hostname3 }}"
node_type: execution
node_state: installed
capacity_adjustment: 0.4
listener_port: 31337
register: result

View File

@ -1,7 +1,7 @@
# Running Development Environment in Kubernetes using Kind Cluster
## Start Kind Cluster
Note: This environment has been tested on MacOS and Fedora with Docker.
Note: This environment has been tested on MacOS and Fedora with Docker.
If you do not already have Kind, install it from:
https://kind.sigs.k8s.io/docs/user/quick-start/
@ -62,7 +62,7 @@ awx-operator-controller-manager 1/1 1 1 16h
## Deploy AWX into Kind Cluster using the AWX Operator
If have have not made any changes to the AWX Dockerfile, run the following
If you have not made any changes to the AWX Dockerfile, run the following
command. If you need to test out changes to the Dockerfile, see the
"Custom AWX Development Image for Kubernetes" section below.
@ -103,7 +103,7 @@ export COMPOSE_TAG=<IMAGE_TAG>
In the root of the AWX repo:
```bash
make awx-kube-dev-build
make awx-kube-dev-build
docker push $DEV_DOCKER_TAG_BASE/awx_kube_devel:$COMPOSE_TAG
```