Skip to content

Commit

Permalink
Merge pull request #118 from electric-cloud/ECPLUGINS-25
Browse files Browse the repository at this point in the history
Renaming from 'Electric Cloud' to 'CloudBees': md
  • Loading branch information
imago-storm authored May 27, 2019
2 parents 574f1cf + 2a33e6a commit 53f9485
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ EC-Docker plugin uses the Docker Engine API to deploy containers and services on

## Usage ##

1. Install the plugin jar in your local ElectricFlow server
1. Install the plugin jar in your local CloudBees Flow server
`./dev/build.sh --deploy`

2. Login to the ElectricFlow server. Navigate to *Administration->Plugins* and create a configuration for newly installed and promoted EC-Docker plugin.
2. Login to the CloudBees Flow server. Navigate to *Administration->Plugins* and create a configuration for newly installed and promoted EC-Docker plugin.

## Prerequisites:
+ Docker engine must be accessible on TCP port.
Expand Down
2 changes: 1 addition & 1 deletion dsl/procedures/deployService/preface.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p>
User can provide a comma-separated list of networks on which to deploy the container or the swarm service in the service mapping page when mapping the service to a cluster in ElectricFlow. If the network does not already exist then the procedure will create one with the provided subnet and gateway. If no subnet and gateway is specified, Docker uses default values. Each of the user-defined networks can have multiple subnets and gateways. In that case, multiple subnets/gateways must be separated by '|'(pipe). If deploying to a stand-alone Docker engine then the user-defined <b>"bridge"</b> network is created. If deploying to a Docker swarm cluster then the user-defined <b>"overlay"</b> network is created.
User can provide a comma-separated list of networks on which to deploy the container or the swarm service in the service mapping page when mapping the service to a cluster in CloudBees Flow. If the network does not already exist then the procedure will create one with the provided subnet and gateway. If no subnet and gateway is specified, Docker uses default values. Each of the user-defined networks can have multiple subnets and gateways. In that case, multiple subnets/gateways must be separated by '|'(pipe). If deploying to a stand-alone Docker engine then the user-defined <b>"bridge"</b> network is created. If deploying to a Docker swarm cluster then the user-defined <b>"overlay"</b> network is created.
</p>
<p>
For example,
Expand Down
2 changes: 1 addition & 1 deletion dsl/procedures/dockerBuild/postface.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<h3>Output</h3>

<p>After the job runs, you can view the results on the Job Details page in ElectricFlow.
<p>After the job runs, you can view the results on the Job Details page in CloudBees Flow.
</p>

<p>In the <b>runDockerBuild</b> step, click the Log button to see the diagnostic information.
Expand Down
2 changes: 1 addition & 1 deletion dsl/procedures/dockerPull/postface.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<h3>Output</h3>

<p>After the job runs, you can view the results on the Job Details page in ElectricFlow.</p>
<p>After the job runs, you can view the results on the Job Details page in CloudBees Flow.</p>

<p>In the <b>runDockerPull</b> step, click the Log button to see the diagnostic information. </p>

2 changes: 1 addition & 1 deletion dsl/procedures/dockerRun/postface.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<h3>Output</h3>

<p>After the job runs, you can view the results on the Job Details page in ElectricFlow.
<p>After the job runs, you can view the results on the Job Details page in CloudBees Flow.
</p>


Expand Down
10 changes: 5 additions & 5 deletions help/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ on which it is running.</p>
<p>More information about Docker Swarm can be found at <a href="https://docs.docker.com/engine/swarm/key-concepts/">Docker Swarm key concepts</a>.</p>


<h2>ElectricFlow Integration to Docker</h2>
<h2>CloudBees Flow Integration to Docker</h2>

<p>Plugin deploys ElectricFlow service as a single container or as a Docker Swarm service based on whether given Docker endpoint is a stand-alone Docker engine or Docker Swarm cluster manager. Plugin checks type of Docker endpoint at runtime and takes decision to deploy correct type of workload (container or Docker Swarm service) accordingly.</p>
<p>Plugin deploys CloudBees Flow service as a single container or as a Docker Swarm service based on whether given Docker endpoint is a stand-alone Docker engine or Docker Swarm cluster manager. Plugin checks type of Docker endpoint at runtime and takes decision to deploy correct type of workload (container or Docker Swarm service) accordingly.</p>

<p>The TLS mutual authentication and encryption is supported between Docker endpoint and the ElectricFlow agent.</p>
<p>The TLS mutual authentication and encryption is supported between Docker endpoint and the CloudBees Flow agent.</p>

<h2>Integrated Version</h2>

<p>This plugin was tested against Docker Engine 17.06.</p>
<h2>Prerequisite for deploying ElectricFlow service on stand-alone Docker engine</h2>
<h2>Prerequisite for deploying CloudBees Flow service on stand-alone Docker engine</h2>
<p>Docker engine daemon must listen on TCP socket. By default, daemon listens on Unix socket on linux/unix based OSs and on named pipe (npipe://) on windows. </p>
<p>To make above changes, </p>
<ol>
<li>Add '{"hosts": ["tcp://IP:PORT"]}' entry in '/etc/docker/daemon.json' (on linux) and in 'C:\ProgramData\Docker\config\daemon.json' (on Windows) file .</li>
<li>Restart Docker daemon</li>
</ol>
<h2>Prerequisite for deploying ElectricFlow service on Docker Swarm cluster</h2>
<h2>Prerequisite for deploying CloudBees Flow service on Docker Swarm cluster</h2>
<p>Docker Swarm cluster must be already setup and Docker Swarm manager must be accessible over network.</p>

<h2>Prerequisite for supporting TLS based authentication</h2>
Expand Down
2 changes: 1 addition & 1 deletion pages/help.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<h1>@PLUGIN_KEY@</h1>
<p>Plugin version @PLUGIN_VERSION@</p>

<p>Revised on May 23, 2019</p>
<p>Revised on May 27, 2019</p>

<hr style="margin-left: -10px; margin-top: 10px; height: 1px; width: 100%; color: #5981BD;" noshade="noshade"/>
<h1>Contents</h1>
Expand Down

0 comments on commit 53f9485

Please sign in to comment.