Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addon for Ansible Service Broker #59

Merged

Conversation

sabre1041
Copy link
Contributor

Addon for deploying the Ansible Service Broker

@@ -0,0 +1,70 @@
Ansible Service Broker Addon
======================
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a suggestion which you can feel free to ignore, but I find that it's easier to both maintain and understand headings which use #.

$ export MINISHIFT_ENABLE_EXPERIMENTAL=y
```

Start Minishift with the `--service-catalog` flag
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a colon to the end of this sentence.

|`BROKER_AUTH`|Broker Authentication|`{"basicAuthSecret":{"namespace":"ansible-service-broker","name":"asb-auth-secret"}}`|
|`ENABLE_BASIC_AUTH`|Enable Basic Authentication within the Broker|`true`|

Variables can be specified by adding `--addon-env <key=value>` when the addon is being invoked (`minishift start` or `minishift addons apply`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(either by `minishift start` or `minishift addons apply`).

Also, please note the period ending the sentence. :)

Ansible Service Broker Addon
======================

This addon installs the [Ansible Service Broker](https://github.com/openshift/ansible-service-broker)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We refer to add-ons with hyphenation within the documentation -- please do so throughout this document as well. :)


Minishift/CDK must be deployed with the Service Catalog enabled

The Service Catalog can be deployed by adding the `--service-catalog` when starting Minishift. The ability to pass extra flags during startup can be enabled by setting the _MINISHIFT_ENABLE_EXPERIMENTAL_ environmental variable as follows:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the `--service-catalog` flag


* To apply the addon to a running instance of Minishift, execute the following command:

$ minishift addons apply ansible-service-broker
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see one more new line here to separate the command example from the following sentence.


## Remove the Addon

To remove all of the deployed components, execute the following command
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a colon to the end of this sentence.


## Uninstall the addon

To uninstall the addon, execute the following command
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a colon to the end of this sentence.

@sabre1041
Copy link
Contributor Author

@robin-owen updated based on feedback


```
$ minishift start --service-catalog
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sabre1041 I think OpenShift v3.7.0 is advisable for this add-on as 3.6.0 had different implementation for oc cluster up and it did not work always. WDYT?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sabre1041 tested on v 3.7.0 and it worked for me. Going ahead and merging this, please send another PR if you want to set minimum version to v3.7.0 https://docs.openshift.org/latest/minishift/using/addons.html#addon-openshift-version-semantics

$ minishift start --openshift-version v3.7.0 --service-catalog
-- Starting profile 'minishift'
-- Checking if requested hypervisor 'kvm' is supported on this platform ... OK
-- Checking if KVM driver is installed ... 
   Driver is available at /usr/local/bin/docker-machine-driver-kvm ... 
   Checking driver binary is executable ... OK
-- Checking if Libvirt is installed ... OK
-- Checking if Libvirt default network is present ... OK
-- Checking if Libvirt default network is active ... OK
-- Checking the ISO URL ... OK
-- Starting local OpenShift cluster using 'kvm' hypervisor ...
-- Minishift VM will be configured with ...
   Memory:    2 GB
   vCPUs :    2
   Disk size: 20 GB
-- Starting Minishift VM ...................... OK
-- Checking for IP address ... OK
-- Checking if external host is reachable from the Minishift VM ... 
   Pinging 8.8.8.8 ... OK
-- Checking HTTP connectivity from the VM ... 
   Retrieving http://minishift.io/index.html ... OK
-- Checking if persistent storage volume is mounted ... OK
-- Checking available disk space ... 0% used OK
-- Downloading OpenShift binary 'oc' version 'v3.7.0'
 38.51 MiB / 38.51 MiB [=========================================================================================================================================] 100.00% 0s-- Downloading OpenShift v3.7.0 checksums ... OK
-- OpenShift cluster will be configured with ...
   Version: v3.7.0
-- Checking `oc` support for startup flags ... 
   host-config-dir ... OK
   host-data-dir ... OK
   host-pv-dir ... OK
   host-volumes-dir ... OK
   version ... OK
   routing-suffix ... OK
   service-catalog ... OK
Starting OpenShift using openshift/origin:v3.7.0 ...
Pulling image openshift/origin:v3.7.0
Pulled 1/4 layers, 26% complete
Pulled 1/4 layers, 42% complete
Pulled 1/4 layers, 57% complete
Pulled 1/4 layers, 72% complete
Pulled 2/4 layers, 76% complete
Pulled 3/4 layers, 88% complete
Pulled 3/4 layers, 99% complete
Pulled 4/4 layers, 100% complete
Extracting
Image pull complete
OpenShift server started.

The server is accessible via web console at:
    https://192.168.42.113:8443

You are logged in as:
    User:     developer
    Password: <any value>

To login as administrator:
    oc login -u system:admin

[lmohanty@LalatenduM-laptop minishift-addons]$ minishift addon apply ansible-service-broker
-- Applying addon 'ansible-service-broker':.......
Ansible Service Broker Deployed


```
$ minishift start --service-catalog
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sabre1041 tested on v 3.7.0 and it worked for me. Going ahead and merging this, please send another PR if you want to set minimum version to v3.7.0 https://docs.openshift.org/latest/minishift/using/addons.html#addon-openshift-version-semantics

$ minishift start --openshift-version v3.7.0 --service-catalog
-- Starting profile 'minishift'
-- Checking if requested hypervisor 'kvm' is supported on this platform ... OK
-- Checking if KVM driver is installed ... 
   Driver is available at /usr/local/bin/docker-machine-driver-kvm ... 
   Checking driver binary is executable ... OK
-- Checking if Libvirt is installed ... OK
-- Checking if Libvirt default network is present ... OK
-- Checking if Libvirt default network is active ... OK
-- Checking the ISO URL ... OK
-- Starting local OpenShift cluster using 'kvm' hypervisor ...
-- Minishift VM will be configured with ...
   Memory:    2 GB
   vCPUs :    2
   Disk size: 20 GB
-- Starting Minishift VM ...................... OK
-- Checking for IP address ... OK
-- Checking if external host is reachable from the Minishift VM ... 
   Pinging 8.8.8.8 ... OK
-- Checking HTTP connectivity from the VM ... 
   Retrieving http://minishift.io/index.html ... OK
-- Checking if persistent storage volume is mounted ... OK
-- Checking available disk space ... 0% used OK
-- Downloading OpenShift binary 'oc' version 'v3.7.0'
 38.51 MiB / 38.51 MiB [=========================================================================================================================================] 100.00% 0s-- Downloading OpenShift v3.7.0 checksums ... OK
-- OpenShift cluster will be configured with ...
   Version: v3.7.0
-- Checking `oc` support for startup flags ... 
   host-config-dir ... OK
   host-data-dir ... OK
   host-pv-dir ... OK
   host-volumes-dir ... OK
   version ... OK
   routing-suffix ... OK
   service-catalog ... OK
Starting OpenShift using openshift/origin:v3.7.0 ...
Pulling image openshift/origin:v3.7.0
Pulled 1/4 layers, 26% complete
Pulled 1/4 layers, 42% complete
Pulled 1/4 layers, 57% complete
Pulled 1/4 layers, 72% complete
Pulled 2/4 layers, 76% complete
Pulled 3/4 layers, 88% complete
Pulled 3/4 layers, 99% complete
Pulled 4/4 layers, 100% complete
Extracting
Image pull complete
OpenShift server started.

The server is accessible via web console at:
    https://192.168.42.113:8443

You are logged in as:
    User:     developer
    Password: <any value>

To login as administrator:
    oc login -u system:admin

[lmohanty@LalatenduM-laptop minishift-addons]$ minishift addon apply ansible-service-broker
-- Applying addon 'ansible-service-broker':.......
Ansible Service Broker Deployed

@LalatenduMohanty LalatenduMohanty dismissed kowen-rh’s stale review December 18, 2017 21:02

Comments are addressed.

@LalatenduMohanty LalatenduMohanty merged commit df9a531 into minishift:master Dec 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants