You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by an...@apache.org on 2018/02/26 13:22:13 UTC
brooklyn-docs git commit: improve OpenStack documentation
Repository: brooklyn-docs
Updated Branches:
refs/heads/master 5b78602c9 -> 2f2ed97c4
improve OpenStack documentation
- describes how to link Neutron to Nova
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/2f2ed97c
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/2f2ed97c
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/2f2ed97c
Branch: refs/heads/master
Commit: 2f2ed97c4fc68a086723c965077ce54204b4ecba
Parents: 5b78602
Author: andreaturli <an...@gmail.com>
Authored: Mon Feb 26 12:44:37 2018 +0100
Committer: andreaturli <an...@gmail.com>
Committed: Mon Feb 26 14:20:55 2018 +0100
----------------------------------------------------------------------
guide/locations/_openstack.md | 67 +++++++++++++++++++++++++++++++-------
1 file changed, 56 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/2f2ed97c/guide/locations/_openstack.md
----------------------------------------------------------------------
diff --git a/guide/locations/_openstack.md b/guide/locations/_openstack.md
index fa5947b..2d0061f 100644
--- a/guide/locations/_openstack.md
+++ b/guide/locations/_openstack.md
@@ -1,23 +1,69 @@
## OpenStack
-### Apache jclouds
-Support for OpenStack is provided by Apache jclouds. For more information, see their guide
-[here](https://jclouds.apache.org/guides/openstack/).
+Brooklyn requires the following API to deploy an application onto an OpenStack-based provider
+
+- Identity API (a.k.a. OpenStack Keystone): [Identity API v2](https://developer.openstack.org/api-ref/identity/v2/) and [Identity API v3](https://developer.openstack.org/api-ref/identity/v3/) The Identity API provides an authentication and authorization service for other OpenStack services. It also provides a catalog of endpoints for all OpenStack services, like the Compute service, a.k.a OpenStack Nova.
+
+- Compute API (a.k.a. OpenStack Nova): [Compute API](https://developer.openstack.org/api-ref/compute/) manages the lifecycle of compute instances in an OpenStack environment. Responsibilities include spawning, scheduling and decommissioning of machines on demand by talking to different hypervisors.
+In some old OpenStack installations, `Nova SecurityGroupAPI extension` is generally used to manage Security Groups, when required.
+- Networking API (a.k.a OpenStack Neutron): [Network API v2.0](https://developer.openstack.org/api-ref/network/v2) enables network connectivity as a service for other OpenStack services, such as OpenStack Compute. It provides an API for users to define networks and the attachments into them. It has a pluggable architecture that supports many popular networking vendors and technologies.
+
+Apache jclouds may optionally need to talk to the `OpenStack Neutron API` to manage networks, subnets, security groups and ports, by linking [Neutron Context to Nova Context](http://jclouds.apache.org/blog/2018/02/06/nova-neutron/).
+
+In some cases it may be required to leverage OpenStack Neutron Extensions such as LoadBalancer-aaS, the FloatingIp API, the Router API or the Firewall-aaS API when available.
+
+Brooklyn offers supports up to [OpenStack Pike](https://releases.openstack.org/pike/index.html) release via Apache jclouds. For more information, see their guide
+[here](https://jclouds.apache.org/guides/openstack/).
### Connection Details
-The endpoint URI is that of keystone (normally on port 5000).
+The endpoint URI is that of keystone (normally on port 5000), notice v2 or v3 suffix may be required.
-The identity normally consists of a colon-separated tenant and username. The credential is
-the password. For example:
+The identity normally consists of a colon-separated tenant and username. The credential is the password. For example:
location:
- jclouds:openstack-nova:
- endpoint: http://x.x.x.x:5000/v2.0/
- identity: "your-tenant:your-username"
- credential: your-password
+ jclouds:openstack-nova
+ brooklyn.config:
+ endpoint: http://x.x.x.x:5000/v3
+ identity: "your-tenant:your-username"
+ credential: password
+ jclouds.keystone.version: 3 # default is `2`
+ # Authorization Scopes - optional
+ # Project scoped authorization (can use the project name or the ID)
+ # jclouds.keystone.scope: 'project:project-id' # or 'project:project-name'
+ # Domain scoped authorization (can use the domain name or the ID)
+ # jclouds.keystone.scope: 'domain:domain-id' # or 'domain:domain-name'
+
+Notice, by default, openstack-nova location tries to manage network concepts required for the deployment in this order:
+
+1. Use OpenStack Networking API to manage security groups and floating IPs, if linked.
+2. Use OpenStack Nova SecurityGroupApi and FloatingIpApi extensions as fallback strategies, if available.
+
+To link Openstack Neutron context use the following YAML schema:
+
+ location:
+ jclouds:openstack-nova
+ brooklyn.config:
+ endpoint: http://x.x.x.x:5000/v3
+ identity: "your-tenant:your-username"
+ credential: password
+ jclouds.keystone.version: 3 # default is `2`
+ # Authorization Scopes - optional
+ # Project scoped authorization (can use the project name or the ID)
+ # jclouds.keystone.scope: 'project:project-id' # or 'project:project-name'
+ # Domain scoped authorization (can use the domain name or the ID)
+ # jclouds.keystone.scope: 'domain:domain-id' # or 'domain:domain-name'
+ # neutron
+ jclouds.linkContext:
+ - $brooklyn:object:
+ type: org.apache.brooklyn.location.jclouds.domain.JcloudsContext
+ object.fields:
+ providerOrApi: openstack-neutron
+ # Additional credentials for OpenStack Neutron - optional
+ # identity: identity # by default, it's OpenStack Nova identity
+ # credential: credential # by default, it's OpenStack Nova credential
OpenStack Nova access information can be downloaded from the openstack web interface, for example
as an openrc.sh file. It is usually available from API Access tab in "Access & Security" section.
@@ -27,7 +73,6 @@ Users are strongly recommended to use
[externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) for better
credential management, for example using [Vault](https://www.vaultproject.io/).
-
### Common Configuration Options
Below are examples of configuration options that use values specific to OpenStack environments: