In this tutorial, we'll walk through the creation of some sample APBs. We will create actions for them to allow provision, deprovision, bind, and unbind. You can find more information about the design of APBs in the design doc. More in-depth information about writing APBs is available in the developers doc
Note: For the remainder of this tutorial, substitute your own information for items marked in brackets, for example <host>:<port> might need to be replaced with 172.17.0.1.nip.io:8443.
Before getting started with APBs, we need to get your system set up to create them.
First, make sure your system is properly running OpenShift Origin. You should be running both the service catalog and Ansible Service Broker (ASB). Instructions can be found on the ASB repo. for Kubernetes getting started doc and OpenShift getting started doc.
Next, install the APB tools as documented in the APB CLI Tooling doc. To check, you can run apb help and check for a valid response.
$ apb help
usage: apb [-h] [--debug] [--project BASE_PATH]
{init,help,prepare,push,bootstrap,list,remove,build} ...
APB tooling for assisting in building and packaging APBs.
optional arguments:
-h, --help show this help message and exit
--debug Enable debug output
--project BASE_PATH, -p BASE_PATH
Specify a path to your project. Defaults to CWD.
subcommand:
{init,help,prepare,push,bootstrap,list,remove,build}
init Initialize the directory for APB development
help Display this help message
prepare Prepare an ansible-container project for APB packaging
push Push local APB spec to an Ansible Service Broker
bootstrap Tell Ansible Service Broker to reload APBs from the
container repository
list List APBs from the target Ansible Service Broker
remove Remove APBs from the target Ansible Service Broker
build Build and package APB container
In this tutorial, we'll create an APB for a containerized hello world application. We'll work through a basic APB that will mirror the hello-world-apb.
Our first task is to create the skeleton for your app using the apb tool. The command for this is simple:
$ apb init my-test-apbAt this point you will see the following file structure
my-test-apb/
├── apb.yml
├── Dockerfile
├── playbooks
│ ├── deprovision.yml
│ └── provision.yml
└── roles
├── deprovision-my-test-apb
│ └── tasks
│ └── main.yml
└── provision-my-test-apb
└── tasks
└── main.yml
Two files were created at the root directory, an apb.yml and a Dockerfile. These are the minimum required for any APB. For more information about the apb spec, visit the developer doc. There is also an explanation of what we can do in the Dockerfile.
# apb.yml
version: 1.0
name: my-test-apb
description: This is a sample application generated by apb init
bindable: False
async: optional
metadata:
displayName: my-test
plans:
- name: default
description: This default plan deploys my-test-apb
free: True
metadata: {}
parameters: []# Dockerfile
FROM ansibleplaybookbundle/apb-base
LABEL "com.redhat.apb.spec"=\
COPY playbooks /opt/apb/actions
COPY roles /opt/ansible/roles
RUN chmod -R g=u /opt/{ansible,apb}
USER apbWe now need to update the com.redhat.apb.spec LABEL with a base64 encoded version of apb.yml. To do this we need to run apb prepare
$ cd my-test-apb
$ apb prepare# Dockerfile
FROM ansibleplaybookbundle/apb-base
LABEL "com.redhat.apb.spec"=\
"dmVyc2lvbjogMS4wCm5hbWU6IG15LXRlc3QtYXBiCmRlc2NyaXB0aW9uOiBUaGlzIGlzIGEgc2Ft\
cGxlIGFwcGxpY2F0aW9uIGdlbmVyYXRlZCBieSBhcGIgaW5pdApiaW5kYWJsZTogRmFsc2UKYXN5\
bmM6IG9wdGlvbmFsCm1ldGFkYXRhOgogIGRpc3BsYXlOYW1lOiBteS10ZXN0CnBsYW5zOgogIC0g\
bmFtZTogZGVmYXVsdAogICAgZGVzY3JpcHRpb246IFRoaXMgZGVmYXVsdCBwbGFuIGRlcGxveXMg\
bXktdGVzdC1hcGIKICAgIGZyZWU6IFRydWUKICAgIG1ldGFkYXRhOiB7fQogICAgcGFyYW1ldGVy\
czogW10="
COPY playbooks /opt/apb/actions
COPY roles /opt/ansible/roles
RUN chmod -R g=u /opt/{ansible,apb}
USER apbAt this point we have a fully formed APB that we can build. If you skipped the apb prepare, apb build will still prepare the apb before building the image.
$ apb buildAt this point, you can push the new APB image to the local OpenShift registry.
$ apb pushQuerying the ansible service broker will now show your new apb listed.
$ apb list
ID NAME DESCRIPTION
< ------------ ID -------------> dh-my-test-apb This is a sample application generated by apb initVisiting the OpenShift console UI will now display the new Ansible Playbook Bundle named "my-test" in the catalog under the All tab and Other tab.
The brand new APB created in the last section doesn't do very much. For that, we'll have to add some actions. The actions supported are provision, deprovision, bind, unbind, and test. We'll add each of these actions in the following sections.
Before we begin, make sure you're logged in through the command line. This will insure the apb tool can interact with OpenShift and the Ansible Service Broker (ASB).
# substitute your information for <oc-cluster-host>:<oc-cluster-port>
oc login --insecure-skip-tls-verify <oc-cluster-host>:<oc-cluster-port> -u admin -p admin
You should also be able login (as admin/admin if you're using catasb) and see your APB listed in the web UI.
Before we go any further, create a project named getting-started for us to deploy resources. You can create it in the web UI or from the command line.
oc new-project getting-startedDuring the apb init process 2 parts of the provision task were stubbed out. The playbook, playbooks/provision.yml, and the associated role in roles/provision-my-test-apb.
my-test-apb
├── apb.yml
├── Dockerfile
├── playbooks
│ └── provision.yml # inspect this playbook
└── roles
└── provision-my-test-apb
└── tasks
└── main.yml # edit this role
playbooks/provision.yml is the Ansible playbook that will be run when the provision action is called from the Ansible Service Broker. You can change the playbook, but for now you can just leave the code as is.
- name: my-test-apb playbook to provision the application
hosts: localhost
gather_facts: false
connection: local
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: ansibleplaybookbundle.asb-modules
- role: provision-my-test-apb
playbook_debug: falseprovision.yml is a new Ansible playbook which will execute on localhost and execute the role provision-my-test-apb. This playbook works on its local container created by the service broker. The ansible.kubernetes-modules role will allow us to use the kubernetes-modules to create our OpenShift resources. The asb-modules provide some additional functionality for use with the Ansible Service Broker.
Currently, there are no tasks in the role. The contents of file roles/provision-my-test-apb/tasks/main.yml only contains comments showing common resource creation tasks. You can currently execute the provision task, but since there are no tasks to perform, it would simply launch the APB container and exit without deploying anything.
Feel free to try this now by clicking on the my-test APB and deploying it to the getting-started project using the wizard.
If you look carefully, when the provision is executing, a new namespace was created with the name dh-my-test-apb-prov-<random>. In development mode, it will persist, but usually this namespace would be deleted after successful completion. By looking at the pod resources, you can see the log for the execution of the APB. In order to find these namespaces you can view all namespaces and sort by creation date or use oc get ns.
$ oc get ns
NAME STATUS AGE
ansible-service-broker Active 1h
default Active 1h
dh-my-test-apb-prov-<random> Active 4m
...
$ oc project dh-my-test-apb-prov-<random>
Now using project "dh-my-test-apb-prov-<random>" on server "<oc-cluster-host>:<oc-cluster-port>".
$ oc get pods
NAME READY STATUS RESTARTS AGE
<apb-pod-name> 0/1 Completed 0 3m
$ oc logs -f <apb-pod-name>
...
+ ansible-playbook /opt/apb/actions/provision.yml --extra-vars '{"_apb_plan_id":"default","namespace":"getting-started"}'
PLAY [my-test-apb playbook to provision the application] ***********************
TASK [ansible.kubernetes-modules : Install latest openshift client] *************
skipping: [localhost]
TASK [ansibleplaybookbundle.asb-modules : debug] *******************************
skipping: [localhost]
PLAY RECAP *********************************************************************
localhost : ok=0 changed=0 unreachable=0 failed=0At the minimum, our APB should deploy the application pods. We'll do this by specifying a deployment config. One of the first tasks that's commented out in the provision-my-test-apb/tasks/main.yml is the creation of the deployment config. You can uncomment it or paste the following. Normally, you would replace the image: value with your own application image and
- name: create deployment config
openshift_v1_deployment_config:
name: my-test
namespace: '{{ namespace }}'
labels:
app: my-test
service: my-test
replicas: 1
selector:
app: my-test
service: my-test
spec_template_metadata_labels:
app: my-test
service: my-test
containers:
- env:
image: docker.io/ansibleplaybookbundle/hello-world:latest # replace with your application image
name: my-test
ports:
- container_port: 8080
protocol: TCP- The
namespacefield will designate which namespace the deployment config should be in. - The
labelsare used to help us organize, group, and select objects. replicas: 1specifies that we only want 1 pod.- The
selectorsection is a label query over pods.
In the containers section, we have specified a container with a hello-world app running on port 8080 on TCP. The image is stored on docker.io/ansibleplaybookbundle/hello-world. For more information, the developers guide has more detail and you can also visit the ansible-kubernetes-modules code documentation for a full accounting of all fields.
If you build, push, and provision the apb there will be a new running pod and a new deployment config.
- Build and Push:
$ apb build
$ apb push
-
Provision using the Web Console UI. This is best done by deleting and recreating the
getting-startedproject so that themy-testcan be provisioned afresh. -
Check your resources
$ oc project getting-started
$ oc get all
NAME REVISION DESIRED CURRENT TRIGGERED BY
dc/my-test 1 1 1 config
NAME DESIRED CURRENT READY AGE
rc/my-test-1 1 1 1 35s
NAME READY STATUS RESTARTS AGE
po/my-test-1-2pw4t 1/1 Running 0 33s
You will also be able to see the deployed application in the console UI at https://<oc-cluster-host>:<oc-cluster-port>/console/project/getting-started/overview. The only way to use this pod currently is to use oc describe pods/<pod-name>, to find out its IP address and access it directly. If we had multiple pods, they'd be accessed separately. To treat them like a single host, we'd need to create a service
To clean up before moving on and allow us to provision again, feel free to delete the getting-started namespace and recreate it or create a new one.
We want to use multiple pods, load balance them, and create a service so that a user can access them as a single host. Let's create that service and modify the same provision-my-test-apb/tasks/main.yml by adding the following:
- name: create my-test service
k8s_v1_service:
name: my-test
namespace: '{{ namespace }}'
labels:
app: my-test
service: my-test
selector:
app: my-test
service: my-test
ports:
- name: web
port: 80
target_port: 8080The selector will allow the my-test service to include the correct pods. The ports will take the target port from the pods (8080) and expose them as a single port for the service (80). Notice the application was running on 8080 but has now been made available on the default http port of 80. The name field of the port will allow us to specify this port in the future with other resources. More information is available in the k8s_v1_service module.
If you rebuild the APB with apb build, push it using apb push, and provision it, you will see a new service in the UI or on the command line. In the UI (), you can click on the new service under Networking in the application on the overview page or under Applications -> Services. The service's IP address will be shown which you can use to access the load balanced application. To view the service information from the command line, you can do the following:
$ oc project getting-started
$ oc get services
$ oc describe services/my-test
The describe command will show the IP address to access the service. Using an IP address for users to access our application isn't generally what we want. Generally, we want to create a route.
We want to expose external access to our application through a reliable named route.
- name: create my-test route
openshift_v1_route:
name: my-test
namespace: '{{ namespace }}'
labels:
app: my-test
service: my-test
to_name: my-test
spec_port_target_port: webThe to_name is name of the target service. spec_port_target_port refers to the name of the target service's port. More information is available in the openshift_v1_route module.
If you rebuild the APB with apb build, push it using apb push, and provision it, you will see the new route created. On the console UI overview page for the getting-started project, you will now see an active and clickable route link listed on the application. Clicking on the route or visiting the URL will bring up the hello-world app. From the command line, you can also view the route information.
$ oc project getting-started
$ oc get routes
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
my-test my-test-getting-started.172.17.0.1.nip.io my-test web None
$ oc describe routes/my-test
Name: my-test
Namespace: getting-started
...
At this point, our my-test application is fully functional, load balanced, scalable, and accessible. You can compare your finished APB to the hello-world APB at apb-examples.
In the deprovision task, we need to destroy all provisioned resources, usually in reverse order.
To add the deprovision action, we need a deprovision.yml inside the playbooks directory and tasks in roles/deprovision-my-test-apb/tasks/main.yml. Both these files have been created for you, but like
my-test-apb/
├── apb.yml
├── Dockerfile
├── playbooks
│ └── provision.yml # inspect this file
└── roles
└── deprovision-my-test-apb
└── tasks
└── main.yml # edit this file
You can look at the code playbooks/deprovision.yml which should look like:
- name: my-test-apb playbook to deprovision the application
hosts: localhost
gather_facts: false
connection: local
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: ansibleplaybookbundle.asb-modules
- role: deprovision-my-test-apb
playbook_debug: falseThe content looks the same as the provision task, except it's calling a different role. Let's edit that role now in the file roles/deprovision-my-test-apb/tasks/main.yml. By uncommenting the tasks, the resulting file without comments should look like the following:
- openshift_v1_route:
name: my-test
namespace: '{{ namespace }}'
state: absent
- k8s_v1_service:
name: my-test
namespace: '{{ namespace }}'
state: absent
- openshift_v1_deployment_config:
name: my-test
namespace: '{{ namespace }}'
state: absentIn provision.yml, created earlier, we created the deployment config, service, then route. For the deprovision action, we'll want to delete the resources in reverse order. We do so by identifying the resource by namespace and name and then marking it as state: absent.
To run the deprovision template, click on the menu on the list of Deployed Services and select Delete.
From the previous sections, we learned how to deploy a standalone application. However, in most cases applications will need to communicate with other applications, often a data source. In the following sections we'll create a PostgreSQL database that the hello-world application deployed from my-test-apb can use.
For a look at executing the bind action playbooks using asynchronous bind and bind parameters, look here to try out the experimental feature. This will be enabled by default when Kubernetes supports asynchronous bind
To give us a good starting point, we'll create the necessary files for provision and deprovisioning PostgreSQL. A more in-depth example can be found at the APB example for Postgres.
apb init my-pg-apb --bindable
This will create the normal APB file structure with a few differences.
my-pg-apb/
├── apb.yml # bindable flag set to true
├── Dockerfile
├── playbooks
│ ├── bind.yml # new file
│ ├── deprovision.yml
│ ├── provision.yml
│ └── unbind.yml # new file
└── roles
├── bind-my-pg-apb
│ └── tasks
│ └── main.yml # new empty file
├── deprovision-my-pg-apb
│ └── tasks
│ └── main.yml
├── provision-my-pg-apb
│ └── tasks
│ └── main.yml # encode binding credentials
└── unbind-my-pg-apb
└── tasks
└── main.yml # new empty file
In addition to the normal files, new playbooks bind.yml, unbind.yml, and their associated roles have been stubbed out. bind.yml and unbind.yml are both empty and since we're using the default binding behavior, will remain empty.
Edit the apb.yml. Notice the setting bindable: true. In addition to those changes, we need to add some parameters to the apb.yml for configuring PostgreSQL. These will be the available fields to configure in the GUI when provisioning our new APB.
version: 1.0
name: my-pg-apb
description: This is a sample application generated by apb init
bindable: True
async: optional
metadata:
displayName: my-pg
plans:
- name: default
description: This default plan deploys my-pg-apb
free: True
metadata: {}
# edit the parameters and add the ones below.
parameters:
- name: postgresql_database
title: PostgreSQL Database Name
type: string
default: admin
- name: postgresql_user
title: PostgreSQL User
type: string
default: admin
- name: postgresql_password
title: PostgreSQL Password
type: string
default: adminThe playbooks/provision.yml will look like the following:
- name: my-pg-apb playbook to provision the application
hosts: localhost
gather_facts: false
connection: local
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: ansibleplaybookbundle.asb-modules
- role: provision-my-pg-apb
playbook_debug: false
The playbooks/deprovision.yml will look like the following:
- name: my-pg-apb playbook to deprovision the application
hosts: localhost
gather_facts: false
connection: local
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: deprovision-my-pg-apb
playbook_debug: falseEdit the roles/provision-my-pg-apb/tasks/main.yml. This mirrors our hello-world application in many respects but adds a persistent volume to save data between restarts and various configuration options for the deployment config.
In addition a new task has been added at the very bottom after the provision tasks. To save the credentials created during the provision process, we need to encode them for retrieval by the Ansible Service Broker. The new task, using the module asb_encode_binding will do so for us.
You can safely delete everything in that file and replace it with the following:
# New persistent volume claim
- name: create volumes
k8s_v1_persistent_volume_claim:
name: my-pg
namespace: '{{ namespace }}'
state: present
access_modes:
- ReadWriteOnce
resources_requests:
storage: 1Gi
- name: create deployment config
openshift_v1_deployment_config:
name: my-pg
namespace: '{{ namespace }}'
labels:
app: my-pg
service: my-pg
replicas: 1
selector:
app: my-pg
service: my-pg
spec_template_metadata_labels:
app: my-pg
service: my-pg
containers:
- env:
- name: POSTGRESQL_PASSWORD
value: '{{ postgresql_password }}'
- name: POSTGRESQL_USER
value: '{{ postgresql_user }}'
- name: POSTGRESQL_DATABASE
value: '{{ postgresql_database }}'
image: docker.io/centos/postgresql-94-centos7
name: my-pg
ports:
- container_port: 5432
protocol: TCP
termination_message_path: /dev/termination-log
volume_mounts:
- mount_path: /var/lib/pgsql/data
name: my-pg
working_dir: /
volumes:
- name: my-pg
persistent_volume_claim:
claim_name: my-pg
test: false
triggers:
- type: ConfigChange
- name: create service
k8s_v1_service:
name: my-pg
namespace: '{{ namespace }}'
state: present
labels:
app: my-pg
service: my-pg
selector:
app: my-pg
service: my-pg
ports:
- name: port-5432
port: 5432
protocol: TCP
target_port: 5432
# New encoding task makes credentials available to future bind operations
- name: encode bind credentials
asb_encode_binding:
fields:
DB_TYPE: postgres
DB_HOST: my-pg
DB_PORT: "5432"
DB_USER: "{{ postgresql_user }}"
DB_PASSWORD: "{{ postgresql_password }}"
DB_NAME: "{{ postgresql_database }}"
The encode bind credentials task will make available several fields as environment variables, DB_TYPE, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME. This is the default behavior when the bind.yml file is left empty. Any application (such as hello-world) can use these environment variables to connect to the configured database after performing a bind operation.
Edit the roles/deprovision-my-pg-apb/tasks/main.yml and delete the created resources.
- k8s_v1_service:
name: my-pg
namespace: '{{ namespace }}'
state: absent
- openshift_v1_deployment_config:
name: my-pg
namespace: '{{ namespace }}'
state: absent
- k8s_v1_persistent_volume_claim:
name: my-pg
namespace: '{{ namespace }}'
state: absentWhen all this is complete, build and push your APB.
apb build
apb pushAt this point, the APB can create a fully functional Postgres database to our cluster. Let's test it out now.
To test your app, we'll bind a hello-world app to the provisioned Postgres database. You can use the application previously created in the provision section of this tutorial or you can use the hello-world-apb. Provision my-test-apb first. Then, we'll want to provision my-pg-apb and select the option to Create a secret....
Now, if you have not already done so, navigate to the project, you can see both your hello-world application and your Postgres database. If you did not select to create a binding at provision time, you can also do so here with the Create binding link.
If you have created the binding, we need to add the secret created by the binding into the application. First navigate to the secrets, Resources -> Secrets.
Now, we need to add the secret as environment variables.
After this addition, you can return to the overview. The my-test application may be redeploying from the configuration change. If so wait and click on the route to view the application. At this point, you will see the hello-world application has detected and connected to the my-pg database.
The intention the test action is to check that an APB passes a basic sanity check before publishing to the service catalog. This is not meant to be testing a live service. OpenShift provides the ability to test a live service using liveness and readiness probes, which you can add when provisioning.
To add the test action to your APB, you just need to create a test.yml in the playbooks directory like this.
my-apb/
├── ...
├── playbooks/
├── test.yml
└── ...The actual implementation of the test is left to you, the APB author. We have added some features to help with the implementation of testing. We have outlined an initial proposal of best practices, but as stated this still in flux, and encourage feedback on what works for you and what does not.
We have added a test command, apb test which can be used to run the test action. The test action will build the image, start up a pod as if you were being run by the service broker, and will retrieve the test results if any were saved. The status of pod after execution has finished will determine the status of the test. If the pod is in an error state, then something failed and we will tell you that the test was unsuccessful.
asb_save_test_result module will allow you to save test results and allows the apb test command to return them. The APB pod will stay alive, for the tool to retrieve test results.
Example:
- name: url check for media wiki
uri:
url: "http://{{ route.route.spec.host }}"
return_content: yes
register: webpage
- name: Save failure for the web page
asb_save_test_result:
fail: true
msg: "Could not reach route and retrieve a 200 status code. Recieved status - {{ webpage.status }}"
when: webpage.status != 200
- fail:
msg: "Could not reach route and retrieve a 200 status code. Recieved status - {{ webpage.status }}"
when: webpage.status != 200
- name: Save test pass
asb_save_test_result:
fail: false
when: webpage.status == 200To test an APB you have built with the internal openshift registry, you can use apb push. This command takes the name of the OpenShift namespace you wish to push the image to. In order to use this feature, the Ansible Service Broker you are running must be configured to bootstrap from the local_openshift registry. Please see the config file documentation to configure the registry for type local_openshift. The following command will build the image with the namespace you passed in as a parameter (by default openshift) and push it to the internal registry.
apb push
To test an APB you have built without pushing your image to a registry, you can use apb push. This command takes the Ansible Service Broker's route as an argument and will push the base64 encoded spec into the list of available APBs for the Broker to deploy. In order to use this feature, the Ansible Service Broker you are running must be configured to run in development mode. In the config file, set devbroker to true. This enables an endpoint to the broker at /v2/apb/ that a user can POST APBs to.
apb push --push-to-broker [--broker <broker_route>]
You should now be able to see your APB in the service catalog.
To get the route of the Ansible Service Broker in OpenShift:
oc project ansible-service-broker
oc get route
If you are running the Broker manually, you must include the Port as well as IP address the Broker is running.
For automation-broker >= 3.10 get-bundle will return the list of bundle
CustomResourceDefinitions.
alias get-bundle='oc get bundle -o custom-columns=Name:spec.fq_name,ID:metadata.name'Return a list of clusterserviceclasses with name, uuid, and the broker they
belong to with csc.
alias csc='oc get clusterserviceclass -o custom-columns=Name:spec.externalName,externalID:spec.externalID,Broker:spec.clusterServiceBrokerName'csp will return a list of clusterserviceplans with name, uuid, and the
broker they are associated with.
alias csp='oc get clusterserviceplan -o custom-columns=Name:spec.externalName,externalID:spec.externalID,Broker:spec.clusterServiceBrokerName,ClusterServiceClass:spec.clusterServiceClassRef.name'- Design - overall design of Ansible Playbook Bundles
- Developers - in-depth explanation of Ansible Playbook Bundles
- APB CLI Tool - installation and usage of the
apbcli tool - OpenShift Origin Docs
- The ansible-kubernetes-modules project.
- Example APBs
- Ansible Service Broker