Skip to content

Commit 791018f

Browse files
author
Brendan Shephard
committed
Remove reference to openstack-ansibleee-operator
Signed-off-by: Brendan Shephard <bshephar@redhat.com>
1 parent 28f7169 commit 791018f

2 files changed

Lines changed: 32 additions & 65 deletions

File tree

‎docs/assemblies/design.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ nodes, or other types of nodes.
99
The openstack-operator provides a Kubernetes like abstraction and API for
1010
deploying the data plane. It uses the
1111
https://github.com/openstack-k8s-operators/openstack-baremetal-operator[openstack-baremetal-operator]
12-
to optionally provision baremetal. It then uses the
13-
https://github.com/openstack-k8s-operators/openstack-ansibleee-operator[openstack-ansibleee-operator]
14-
to execute Ansible to deploy, configure, and orchestrate software on the nodes.
12+
to optionally provision baremetal. It then creates Kubernetes jobs
13+
that execute Ansible to deploy, configure, and orchestrate software on the nodes.
1514
The software is typically RPM or container based using the `podman` container
1615
runtime.
1716

‎docs/assemblies/interacting_with_ansible.adoc‎

Lines changed: 30 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,42 @@
11
= Interacting with Ansible
22

3-
When a dataplane service is executed during a role deployment, a corresponding
4-
https://openstack-k8s-operators.github.io/openstack-ansibleee-operator/openstack_ansibleee/[OpenStackAnsibleEE]
5-
resource is created. The OpenStackAnsibleEE resource is the associated ansible
3+
When a dataplane service is executed during a deployment, a corresponding
4+
Kubernetes Job is created. This Kubernetes Job is the associated ansible
65
execution with the service.
76

8-
OpenStackAnsibleEE resources are reconciled by
9-
https://github.com/openstack-k8s-operators/openstack-ansibleee-operator[openstack-ansibleee-operator].
107
During reconciliation a
118
https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/job-v1/[Job]
129
resource is created which in turn creates a
1310
https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/[Pod] resource. The pod is started with an https://docs.ansible.com/automation-controller/latest/html/userguide/execution_environments.html[Ansible Execution Environment] image, and runs https://ansible.readthedocs.io/projects/runner/en/stable/[ansible-runner].
1411

15-
== Retrieving and inspecting OpenStackAnsibleEE resources
16-
17-
During (or after) a deployment the instances of OpenStackAnsibleEE can be
18-
retrieved from the API.
19-
20-
oc get openstackansibleee
21-
22-
Sample output when the default list of services:
23-
24-
NAME NETWORKATTACHMENTS STATUS MESSAGE
25-
configure-network-edpm-compute True Job completed
26-
configure-os-edpm-compute True Job completed
27-
install-os-edpm-compute True Job completed
28-
libvirt-edpm-compute True Job completed
29-
nova-edpm-compute True Job completed
30-
run-os-edpm-compute True Job completed
31-
telemetry-edpm-compute True Job completed
32-
validate-network-edpm-compute True Job completed
33-
34-
Querying for pods with the OpenStackAnsibleEE label
35-
36-
oc get pods -l app=openstackansibleee
37-
38-
Sample output:
39-
40-
configure-network-edpm-compute-j6r4l 0/1 Completed 0 3m36s
41-
validate-network-edpm-compute-6g7n9 0/1 Pending 0 0s
42-
validate-network-edpm-compute-6g7n9 0/1 ContainerCreating 0 11s
43-
validate-network-edpm-compute-6g7n9 1/1 Running 0 13s
44-
45-
Querying for jobs, shows the corresponding job for each OpenStackAnsibleEE resource:
46-
47-
oc get jobs -l app=openstackansibleee
48-
49-
Sample output:
50-
51-
NAME COMPLETIONS DURATION AGE
52-
configure-network-edpm-compute 1/1 8s 2m51s
53-
configure-os-edpm-compute 1/1 8s 2m27s
54-
install-os-edpm-compute 1/1 8s 2m35s
55-
libvirt-edpm-compute 1/1 8s 2m35s
56-
nova-edpm-compute 1/1 8s 2m35s
57-
run-os-edpm-compute 1/1 8s 2m19s
58-
telemetry-edpm-compute 1/1 8s 2m35s
59-
validate-network-edpm-compute 1/1 8s 2m43s
60-
61-
Using the job name, the corresponding pod can be retrieved:
62-
63-
oc get pods | grep configure-network-edpm-compute
64-
65-
Sample output:
66-
67-
configure-network-edpm-compute-2hshp 0/1 Completed 0 5m45s
68-
69-
Using the job name, the ansible logs can be retrieved:
70-
71-
oc logs job.batch/configure-network-edpm-compute
12+
== Retrieving and inspecting Ansible Execution Jobs
13+
14+
The Kubernetes jobs are labelled with the name of the `OpenStackDataPlaneDeployment`.
15+
Jobs for each `OpenStackDataPlaneDeployment` can be seen by listing jobs by the label:
16+
17+
$ oc get job -l openstackdataplanedeployment=edpm-compute
18+
NAME STATUS COMPLETIONS DURATION AGE
19+
bootstrap-edpm-compute-openstack-edpm-ipam Complete 1/1 78s 25h
20+
configure-network-edpm-compute-openstack-edpm-ipam Complete 1/1 37s 25h
21+
configure-os-edpm-compute-openstack-edpm-ipam Complete 1/1 66s 25h
22+
download-cache-edpm-compute-openstack-edpm-ipam Complete 1/1 64s 25h
23+
install-certs-edpm-compute-openstack-edpm-ipam Complete 1/1 46s 25h
24+
install-os-edpm-compute-openstack-edpm-ipam Complete 1/1 57s 25h
25+
libvirt-edpm-compute-openstack-edpm-ipam Complete 1/1 2m37s 25h
26+
neutron-metadata-edpm-compute-openstack-edpm-ipam Complete 1/1 61s 25h
27+
nova-edpm-compute-openstack-edpm-ipam Complete 1/1 3m20s 25h
28+
ovn-edpm-compute-openstack-edpm-ipam Complete 1/1 78s 25h
29+
run-os-edpm-compute-openstack-edpm-ipam Complete 1/1 33s 25h
30+
ssh-known-hosts-edpm-compute Complete 1/1 19s 25h
31+
telemetry-edpm-compute-openstack-edpm-ipam Complete 1/1 2m5s 25h
32+
validate-network-edpm-compute-openstack-edpm-ipam Complete 1/1 16s 25h
33+
34+
Logs can be checked using `oc logs -f job/<job-name>`. For example, if we want to check the logs
35+
from the configure-network job:
36+
37+
$ oc logs -f jobs/configure-network-edpm-compute-openstack-edpm-ipam | tail -n2
38+
PLAY RECAP *********************************************************************
39+
edpm-compute-0 : ok=22 changed=0 unreachable=0 failed=0 skipped=17 rescued=0 ignored=0
7240

7341
== Controlling the Ansible execution
7442

0 commit comments

Comments
 (0)