Modernized Hello-World APB #3

djzager · 2018-02-05T19:37:00Z

No description provided.

djzager · 2018-02-05T19:38:42Z

I'm playing around/investigating with a "modernized" APB example. The end goal is to have something showing off openshift_raw and k8s_raw as well as a functioning test playbook. Right now though I've restructured this APB into a single role and wanted to get feedback before moving any further.

fabianvf · 2018-02-05T19:43:28Z

playbooks/deprovision.yml

@@ -5,5 +5,6 @@
  roles:
  - role: ansible.kubernetes-modules


I think you won't need this anymore, right?

fabianvf · 2018-02-05T19:46:22Z

roles/hello-world-apb/templates/deployment_config.yml

@@ -0,0 +1,27 @@
+---
+# Notice that the prefix was removed from apps.openshift.io/v1


any reason you aren't inlining these?

fabianvf · 2018-02-05T19:48:34Z

roles/hello-world-apb/vars/deprovision.yml

@@ -0,0 +1,2 @@
+---
+state: absent


Seems a little overkill to have a whole vars directory for these two 1-line files.

I agree. I really just wanted to pull vars out of the playbook but I don't think this improves on that.

djzager · 2018-02-05T20:28:38Z

Example runthrough with multiple provisions in same namespace:

Provision apb with `apb_id=2`

(apb) ➜  hello-world-apb git:(apb-ref-example) ✗ docker run --rm --net=host -v $HOME/.kube:/opt/apb/.kube:z -u $UID hello-world-apb provision --extra-vars 'apb_id=2'
+ [[ provision --extra-vars apb_id=2 == *\s\2\i\/\a\s\s\e\m\b\l\e* ]]
+ ACTION=provision
+ shift
+ playbooks=/opt/apb/actions
+ CREDS=/var/tmp/bind-creds
+ TEST_RESULT=/var/tmp/test-result
+ whoami
+ '[' -w /etc/passwd ']'
++ id -u
+ echo 'apb:x:1000:0:apb user:/opt/apb:/sbin/nologin'
+ set +x
+ [[ -e /opt/apb/actions/provision.yaml ]]
+ [[ -e /opt/apb/actions/provision.yml ]]
+ ANSIBLE_ROLES_PATH=/etc/ansible/roles:/opt/ansible/roles
+ ansible-playbook /opt/apb/actions/provision.yml --extra-vars apb_id=2

PLAY [hello-world-apb provision] ***********************************************

TASK [hello-world-apb : deployment config] *************************************
changed: [localhost]

TASK [hello-world-apb : hello-world service] ***********************************
changed: [localhost]

TASK [hello-world-apb : create hello-world route] ******************************
changed: [localhost]

PLAY RECAP *********************************************************************
localhost                  : ok=3    changed=3    unreachable=0    failed=0

+ EXIT_CODE=0
+ set +ex
+ '[' -f /var/tmp/test-result ']'
+ exit 0

Provision apb with `apb_id=1`

$  hello-world-apb git:(apb-ref-example) ✗ docker run --rm --net=host -v $HOME/.kube:/opt/apb/.kube:z -u $UID hello-world-apb provision --extra-vars 'apb_id=1'
+ [[ provision --extra-vars apb_id=1 == *\s\2\i\/\a\s\s\e\m\b\l\e* ]]
+ ACTION=provision
+ shift
+ playbooks=/opt/apb/actions
+ CREDS=/var/tmp/bind-creds
+ TEST_RESULT=/var/tmp/test-result
+ whoami
+ '[' -w /etc/passwd ']'
++ id -u
+ echo 'apb:x:1000:0:apb user:/opt/apb:/sbin/nologin'
+ set +x
+ [[ -e /opt/apb/actions/provision.yaml ]]
+ [[ -e /opt/apb/actions/provision.yml ]]
+ ANSIBLE_ROLES_PATH=/etc/ansible/roles:/opt/ansible/roles
+ ansible-playbook /opt/apb/actions/provision.yml --extra-vars apb_id=1

PLAY [hello-world-apb provision] ***********************************************

TASK [hello-world-apb : deployment config] *************************************
changed: [localhost]

TASK [hello-world-apb : hello-world service] ***********************************
changed: [localhost]

TASK [hello-world-apb : create hello-world route] ******************************
changed: [localhost]

PLAY RECAP *********************************************************************
localhost                  : ok=3    changed=3    unreachable=0    failed=0

+ EXIT_CODE=0
+ set +ex
+ '[' -f /var/tmp/test-result ']'
+ exit 0

See all in the namespace

$ oc get all -n hello-world
NAME                                                                 REVISION   DESIRED   CURRENT   TRIGGERED BY
deploymentconfigs/hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab   1          1         0         config
deploymentconfigs/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   1          1         0         config

NAME                                                      HOST/PORT                                                                        PATH      SERVICES                                           PORT      TERMINATION   WILDCARD
routes/hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab   hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab-hello-world.172.17.0.1.nip.io             hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab   web                     None
routes/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676-hello-world.172.17.0.1.nip.io             hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   web                     None

NAME                                                           READY     STATUS    RESTARTS   AGE
po/hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab-1-deploy   0/1       Error     0          14s
po/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676-1-deploy   0/1       Error     0          8s

NAME                                                    DESIRED   CURRENT   READY     AGE
rc/hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab-1   0         0         0         14s
rc/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676-1   0         0         0         8s

NAME                                                   TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
svc/hello-world-5acebd43-ef18-5da4-9d08-543ae781fcab   ClusterIP   172.30.237.56    <none>        8080/TCP   13s
svc/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   ClusterIP   172.30.221.152   <none>        8080/TCP   7s

Deprovision `apb_id=2`

$ docker run --rm --net=host -v $HOME/.kube:/opt/apb/.kube:z -u $UID hello-world-apb deprovision --extra-vars 'apb_id=2'
+ [[ deprovision --extra-vars apb_id=2 == *\s\2\i\/\a\s\s\e\m\b\l\e* ]]
+ ACTION=deprovision
+ shift
+ playbooks=/opt/apb/actions
+ CREDS=/var/tmp/bind-creds
+ TEST_RESULT=/var/tmp/test-result
+ whoami
+ '[' -w /etc/passwd ']'
++ id -u
+ echo 'apb:x:1000:0:apb user:/opt/apb:/sbin/nologin'
+ set +x
+ [[ -e /opt/apb/actions/deprovision.yaml ]]
+ [[ -e /opt/apb/actions/deprovision.yml ]]
+ ANSIBLE_ROLES_PATH=/etc/ansible/roles:/opt/ansible/roles
+ ansible-playbook /opt/apb/actions/deprovision.yml --extra-vars apb_id=2

PLAY [hello-world-apb deprovision] *********************************************

TASK [hello-world-apb : deployment config] *************************************
changed: [localhost]

TASK [hello-world-apb : hello-world service] ***********************************
changed: [localhost]

TASK [hello-world-apb : create hello-world route] ******************************
changed: [localhost]

PLAY RECAP *********************************************************************
localhost                  : ok=3    changed=3    unreachable=0    failed=0

+ EXIT_CODE=0
+ set +ex
+ '[' -f /var/tmp/test-result ']'
+ exit 0

See if `apb_id=1` survived

$ oc get all -n hello-world
NAME                                                                 REVISION   DESIRED   CURRENT   TRIGGERED BY
deploymentconfigs/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   1          1         0         config

NAME                                                      HOST/PORT                                                                        PATH      SERVICES                                           PORT      TERMINATION   WILDCARD
routes/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676-hello-world.172.17.0.1.nip.io             hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   web                     None

NAME                                                           READY     STATUS    RESTARTS   AGE
po/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676-1-deploy   0/1       Error     0          6m

NAME                                                    DESIRED   CURRENT   READY     AGE
rc/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676-1   0         0         0         6m

NAME                                                   TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
svc/hello-world-dae097b5-4296-5d3f-8cc4-4acee86b3676   ClusterIP   172.30.221.152   <none>        8080/TCP   6m

LorbusChris · 2018-02-05T20:34:44Z

@djzager I'm liking the simplified structure!

Here's an idea of what it could look like to add per-container config-roles (aka container-enabled) to the APB:
https://github.com/djzager/Hello-World-APB/pull/1

dymurray · 2018-02-05T21:37:30Z

roles/hello-world-apb/defaults/main.yml

@@ -0,0 +1,4 @@
+---
+app_name: "hello-world-{{ 99 | random(seed=apb_id) | to_uuid }}"


+1 I like this approach a lot

I like _apb_service_instance_id better :)

We should just make a filter for this, so you could do something like {{ 'hello-world' | apb_uuid }} or something. Would let us control how the names are generated as well, if we could do it deterministically based on the service instance id then idempotence would be easy as well.

How do we make a filter for this? I like this idea a lot...service instance id is a uuid, so it is unique and preserves idempotence. My concern is making it so that when you run the apb without a broker it still works (with sane defaults or you providing the value).

I would also really like it if we were able to untie the APB variables from the broker. By this I mean that _apb_service_instance_id limits that variable to being used only when the APB is associated with a service instance. If we could go to more generics like apb_id or having a filter apb_uuid, I would really be on board.

LorbusChris · 2018-02-06T00:48:21Z

Maybe the container name shouldn't be the same as the pod's name, in case there's multiple containers deployed to the pod and we want to easily differentiate them?

djzager · 2018-02-06T16:37:43Z

roles/hello-world-apb/defaults/main.yml

+---
+app: hello-world
+apb_id: 0
+app_name: "{{ app }}-{{ apb_id }}"


My hope is to have the broker provide the service instance id as apb_id instead of _apb_service_instance_id (and have apb_id passed on all APB actions) to make this work with and w/o a broker. If _apb_service_instance_id stays, then I'll change this.

fabianvf · 2018-02-12T20:26:38Z

apb.yml

 version: 1.0
 name: hello-world-apb
 description: deploys hello-world web application
-bindable: False
+bindable: "False"


any reason these need to be strings and not bools?

https://travis-ci.org/djzager/Hello-World-APB/jobs/339544060

apb.yml 1:1 warning missing document start "---" (document-start) 4:11 warning truthy value is not quoted (truthy) 8:81 error line too long (89 > 80 characters) (line-length) 14:11 warning truthy value is not quoted (truthy) 17:81 error line too long (88 > 80 characters) (line-length)

fabianvf · 2018-02-12T20:26:45Z

apb.yml

  dependencies: ['docker.io/ansibleplaybookbundle/hello-world:latest']
  providerDisplayName: "Red Hat, Inc."
 plans:
  - name: default
    description: A sample APB which deploys Hello World
-    free: True
+    free: "True"


same as above

fabianvf · 2018-02-12T20:27:26Z

playbooks/deprovision.yml

-    playbook_debug: false
+  - role: hello-world-apb
+  vars:
+    state: absent


seems like state should be set by apb_action inside the role

fabianvf · 2018-02-12T20:27:43Z

playbooks/provision.yml

-    playbook_debug: false
+  - role: hello-world-apb
+  vars:
+    state: present


fabianvf · 2018-02-12T20:30:16Z

roles/hello-world-apb/tasks/verify_deprovision.yml

+---
+
+- name: "verify deployment config removed"
+  shell: "oc get deploymentconfig -n {{ namespace }} {{ app_name }}"


I think chouseknecht has added a lookup module for this, probably a good place to showcase it: https://docs.ansible.com/ansible/devel/plugins/lookup/openshift.html

dymurray · 2018-02-12T20:33:15Z

.travis.yml

+    script:
+      # Check if committed APB spec matches Dockerfile
+      - apb build
+      - if ! git diff --exit-code; then echo "Committed APB spec differs from built apb.yml spec"; exit 1; fi


smart, good idea

dymurray · 2018-02-12T20:47:47Z

roles/hello-world-apb/defaults/main.yml

@@ -0,0 +1,10 @@
+---


+1 to how you organized this. Good idea including defaults for what the broker provides

dymurray · 2018-02-12T23:38:07Z

Any ideas why deprovision is failing?

djzager · 2018-02-13T21:32:50Z

roles/hello-world-apb/tasks/verify_deprovision.yml

@@ -0,0 +1,13 @@
+---
+
+- name: "Verify {{ app_name }} objects removed"


@fabianvf @dymurray I scrapped the use of lookups for verification because they don't work as you would expect and I think this is cleaner and makes more sense. I'll consider writing an issue against Ansible, but for now, I think this is the most correct way to do this.

jwmatthews · 2018-02-26T15:58:33Z

@djzager what are next steps with this PR?

djzager · 2018-02-26T17:01:16Z

@jwmatthews The next steps are:

Figure out what to do with the test playbook. If you look at the mariadb-apb HA PR, specifically the test playbook there are some good things going on there that we should investigate. It goes beyond the typical "verifications" that I've seen in other test playbooks and actually interacts with the database as a test. It's also a little complex. I want to be sure that test playbooks are supported by any apb-test-shim we develop. There may be nothing more to do here as the apb-test-shim already runs the test playbook if it exists in the project.
Talk with @dymurray and make sure that what I'm doing here lines up with the ansible-galaxy integration.
Move the apb-test-shim project under one of our organizations.

djzager · 2018-03-06T16:18:10Z

I'm using this PR to test the changes in --> ansibleplaybookbundle/apb-test-shim#4 In the end this will rely on that PR being merged.

djzager · 2018-03-06T16:44:27Z

@fabianvf + @dymurray I think this is ready to go

fabianvf · 2018-03-06T19:23:23Z

tasks/verify_provision.yml

+  when: cluster == "kubernetes"
+
+- name: "Wait for deployment config to be available"
+  command: >-


I think chouseknecht has added a lookup module for this, probably a good place to showcase it: https://docs.ansible.com/ansible/devel/plugins/lookup/openshift.html

I think ansible also has a jsonquery/path filter built in to it, probably should add the dependency to apb-base since it's pretty useful.

@jmontleon
I did a cursory look to see if jmespath was available in the EPEL repo for centos in order to update the apb-base image and it wasn't there. I see a few bugs related to this https://bugzilla.redhat.com/show_bug.cgi?id=1484910 but I don't see how we could update the apb-base with jmespath. If we can't easily add it then I think we should push off the lookup stuff.

djzager · 2018-03-16T19:52:48Z

Updated the example to use lookups based on @fabianvf request. Now this is blocked by ansible/ansible#37533 ... once that is merged I'll make sure everything is good to go and get 👍 again.

fabianvf · 2018-03-20T19:10:51Z

playbooks/deprovision.yml

-    playbook_debug: false
+  - role: ansibleplaybookbundle.asb-modules
+  - role: hello-world-apb
+  vars:


The spacing here and in provision.yml looks weird to me, does this work?

It does work. Not sure what I would do to improve it.

Ah, seeing it in the email cleared it up. Thought the var was attached to the role include and not the play.

dymurray

Looks good to me, I really like the asb_last_operation calls to give us some status reporting. ACK Pending Travis.

djzager · 2018-03-22T13:28:09Z

Putting this here for when I forget. The kubernetes latest is going to fail because of ~~kubernetes/minikube#2629~~

fabianvf

/lgtm

Initial attempt at modernized APB

2e1eca9

djzager added the do-not-merge label Feb 5, 2018

djzager requested review from fabianvf and dymurray February 5, 2018 19:37

fabianvf reviewed Feb 5, 2018

View reviewed changes

djzager added 2 commits February 5, 2018 15:22

Remove unnecessary vars file

6f7c47c

Name objects based on apb_name

dd4396c

dymurray reviewed Feb 5, 2018

View reviewed changes

Use generic for container. Add default for apb_id

cfec4aa

djzager commented Feb 6, 2018

View reviewed changes

djzager added 2 commits February 9, 2018 09:17

Use _apb_service_instance_id

a65cba5

Update readme

7e161c7

fabianvf reviewed Feb 12, 2018

View reviewed changes

dymurray reviewed Feb 12, 2018

View reviewed changes

djzager added 2 commits February 13, 2018 16:31

Add verifications for provision/deprovision

fa36263

Add travis.yml, clean up apb.yml, update Dockerfile

e96daf2

djzager commented Feb 13, 2018

View reviewed changes

djzager added 2 commits February 14, 2018 15:58

Move dockerfile back to apb-base:canary

cca6daa

Add apb identifying info to templates

f11efa6

djzager mentioned this pull request Feb 21, 2018

MariaDB HA via Galera and tests ansibleplaybookbundle/mariadb-apb#23

Open

Use apb-test-shim

0cfbbec

Move back to master branch of apb-test-shim

3b47b40

djzager mentioned this pull request Mar 5, 2018

Custom Playbook Name Proposal openshift/ansible-service-broker#815

Closed

djzager removed the do-not-merge label Mar 5, 2018

djzager changed the title ~~WIP: Initial attempt at modernized APB~~ Initial attempt at modernized APB Mar 5, 2018

djzager changed the title ~~Initial attempt at modernized APB~~ Modernized Hello-World APB Mar 5, 2018

Bump minimum ansible version

06837b9

fabianvf reviewed Mar 6, 2018

View reviewed changes

Use lookups and json_query

781ddc4

djzager added the blocked label Mar 16, 2018

djzager mentioned this pull request Mar 20, 2018

Parametrise service name ansibleplaybookbundle/postgresql-apb#40

Open

Make name a parameter

1ff42d2

djzager removed the blocked label Mar 20, 2018

fabianvf reviewed Mar 20, 2018

View reviewed changes

dymurray approved these changes Mar 20, 2018

View reviewed changes

djzager added 2 commits March 20, 2018 15:42

Fix test playbook

6a9a597

Fix until condition

cd31f6f

djzager mentioned this pull request Mar 26, 2018

Randomize object names to avoid clashes openshift/ansible-service-broker#853

Closed

Name objects with service instance id

06134c4

fabianvf approved these changes Mar 27, 2018

View reviewed changes

djzager merged commit 9843792 into ansibleplaybookbundle:master Mar 27, 2018

		@@ -0,0 +1,27 @@
		---
		# Notice that the prefix was removed from apps.openshift.io/v1

		@@ -0,0 +1,4 @@
		---
		app_name: "hello-world-{{ 99 \| random(seed=apb_id) \| to_uuid }}"

		@@ -0,0 +1,13 @@
		---

		- name: "Verify {{ app_name }} objects removed"

Modernized Hello-World APB #3

Modernized Hello-World APB #3

Conversation

djzager commented Feb 5, 2018

djzager commented Feb 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djzager commented Feb 5, 2018

Provision apb with apb_id=2

Provision apb with apb_id=1

See all in the namespace

Deprovision apb_id=2

See if apb_id=1 survived

LorbusChris commented Feb 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LorbusChris commented Feb 6, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dymurray commented Feb 12, 2018

Choose a reason for hiding this comment

jwmatthews commented Feb 26, 2018

djzager commented Feb 26, 2018

djzager commented Mar 6, 2018

djzager commented Mar 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djzager commented Mar 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dymurray left a comment • edited

Choose a reason for hiding this comment

djzager commented Mar 22, 2018 • edited

fabianvf left a comment

Choose a reason for hiding this comment

Provision apb with `apb_id=2`

Provision apb with `apb_id=1`

Deprovision `apb_id=2`

See if `apb_id=1` survived

LorbusChris commented Feb 6, 2018 •

edited

dymurray left a comment •

edited

djzager commented Mar 22, 2018 •

edited