Skip to content

Commit

Permalink
Adoc back-migration
Browse files Browse the repository at this point in the history
  • Loading branch information
imago-storm committed Oct 21, 2020
1 parent bc62e1d commit 2b25f37
Showing 1 changed file with 4 additions and 42 deletions.
46 changes: 4 additions & 42 deletions help/help.adoc
Original file line number Diff line number Diff line change
@@ -1,29 +1,7 @@

Plugin Version @PLUGIN_VERSION@


Revised on December 25, 2018

== {CD} integration to OpenStack

The plugin communicates with OpenStack through its application programming interface (API), which provides support for developers who are building interactive clients of OpenStack using a RESTful application development style. The EC-OpenStack plugin allows users to build a cloud by launching images and assigning metadata to instances, providing a more generic interface for managing resources.

The plugin interact with OpenStack through the Compute API and Image API using PERL to perform the following tasks:

* Create configurations with the connection information.
* Perform actions on machines.
* Deploy and delete servers.
* Create and delete key pairs.
* Create and delete floating IPs.
* Create {CD} resources.
* Create, attach, detach, extend, and delete volumes.
* Create new images.
* Create a snapshot of a server.
* Do hard and soft reboots of a server.
* Deploy, update, and delete HEAT orchestration templates.

This plugin provides two primary actions: Deploy and Cleanup, which work as a pair within a job.

== Integrated version

This plugin was developed and tested against OpenStack IceHouse.
Expand All @@ -35,14 +13,11 @@ IMPORTANT: For all parameter descriptions in this document, the required paramet
[[setupconfig]]
== Setting up the plugin configuration

[[CreateConfiguration]]


Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined sets of parameters for end users, and store credentials securely. Each configuration has a unique name that is automatically entered in designated parameters in the procedures.

The *Identity Service URL* must have http or https followed by your server hostname or IP address.

==== Input
=== Input

. Go to *Administration* > *Plugins* to open the Plugin Manager.
. Find the EC-OpenStack row.
Expand All @@ -52,7 +27,7 @@ The *Identity Service URL* must have http or https followed by your server hostn

Remember that you may need to create additional configurations later.

==== Output
=== Output

The OpenStack Configurations page now shows the new configuration.

Expand All @@ -61,9 +36,6 @@ You can also manage your OpenStack configurations on this page. Click *Edit* to
[[procedures]]
== Plugin procedures

[[AllocateIP]]


=== AllocateIP

This procedure creates a new OpenStack floating IP address to use with your OpenStack account. The plugin stores properties on the {CD} server in the location in the *Results Location* and *Results tag* fields. The default location in the job directory called /myJob/Openstack/deployed/_Provision tag_ if the *Results Location* is blank.
Expand All @@ -73,7 +45,6 @@ This procedure creates a new OpenStack floating IP address to use with your Open
. Go to the AllocateIP procedure.
. Enter the following parameters:


[cols=",",options="header",]
|===
|Parameter |Description
Expand All @@ -86,11 +57,8 @@ This procedure creates a new OpenStack floating IP address to use with your Open

After the job runs, you can view the results on the Job Details page in {CD}.

In the *AllocateIP* step, click the Log button to see the diagnostic information.

[[AssociateFloatingIP]]


In the *AllocateIP* step, click the *Log* button to see the diagnostic information.
=
=== AssociateFloatingIP

This procedure associates a floating IP address to an existing instance.
Expand All @@ -100,7 +68,6 @@ This procedure associates a floating IP address to an existing instance.
. Go to the AssociateFloatingIP procedure.
. Enter the following parameters:


[cols=",",options="header",]
|===
|Parameter |Description
Expand All @@ -114,8 +81,6 @@ After the job runs, you can view the results on the Job Details page in {CD}.

In the *AssociateFloatingIP* step, click the Log button to see the diagnostic information.

[[AttachVolume]]


=== AttachVolume

Expand Down Expand Up @@ -146,9 +111,6 @@ After the job runs, you can view the results on the Job Details page in Electric

In the *AttachVolume* step, click the Log button to see the diagnostic information.

[[Cleanup]]


=== Cleanup

This procedure deletes an existing OpenStack server instance that was created using the Deploy procedure.
Expand Down

0 comments on commit 2b25f37

Please sign in to comment.