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

View File

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

View File

@@ -1,7 +1,7 @@
# Running Development Environment in Kubernetes using Kind Cluster # Running Development Environment in Kubernetes using Kind Cluster
## Start 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: If you do not already have Kind, install it from:
https://kind.sigs.k8s.io/docs/user/quick-start/ 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 ## 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 command. If you need to test out changes to the Dockerfile, see the
"Custom AWX Development Image for Kubernetes" section below. "Custom AWX Development Image for Kubernetes" section below.
@@ -103,7 +103,7 @@ export COMPOSE_TAG=<IMAGE_TAG>
In the root of the AWX repo: In the root of the AWX repo:
```bash ```bash
make awx-kube-dev-build make awx-kube-dev-build
docker push $DEV_DOCKER_TAG_BASE/awx_kube_devel:$COMPOSE_TAG docker push $DEV_DOCKER_TAG_BASE/awx_kube_devel:$COMPOSE_TAG
``` ```