Commit fd2870eb authored by Agustin Larreinegabe's avatar Agustin Larreinegabe Committed by Truc Nguyen

Change old dependencies mentioned in 3.0

parent f98e52ea
......@@ -7,13 +7,14 @@ On this page you will find detailed information about the BCD CLI with usage exa
* First, the `bcd` command requires that the **`BCD_HOME`** environment variable is set.
By default `BCD_HOME` is set to `/home/bonita/bonita-continuous-delivery` in the controller container.
* Next, the `bcd` command takes a mandatory option called `scenario` through the `-s / --scenario` command line option.
* Next, the `bcd` command takes a ***mandatory option*** called `scenario` through the `-s / --scenario` command line option.
This option expects an existing relative or absolute path to a [BCD YAML scenario](scenarios.md) file.
The BCD scenario path can also be specified through the **`BCD_SCENARIO`** environment variable, hence allowing to skip the `-s / --scenario` command line option.
* Finally, the BCD CLI expects to find Bonita version-specific dependencies in the **`$BCD_HOME/dependencies`** directory. This directory must contain:
* Finally, the BCD CLI expects to find Bonita version-specific dependencies in the **`$BCD_HOME/dependencies/<bonita_version>`** directory that contains:
- `bonita-la-builder-*-exec.jar` - (Mandatory) The Bonita Living Application Builder library
- `bonita-sp-*-maven-repository.zip` - (Optional) The Bonita Maven repository zip if required by your Living Application workspace.
BCD dependencies may be retrieved as `bonitasoft/bcd-dependencies` Docker images and they must be mounted as volumes in the `$BCD_HOME/dependencies` directory.
Since BCD 3.0.0, the dependencies can be retrieved as `quay.io/bonitasoft/bcd-dependencies:<bonita_version>` Docker images and they must be mounted as volumes in the `$BCD_HOME/dependencies` directory.
You can read more about in [Common Installation Steps](getting_started.md#toc1)
## Usage examples
......@@ -100,7 +101,7 @@ You can also see this information by running `bcd --help` and `bcd [SUBCOMMAND]
<dl class="option">
<dt id="cmdoption-bcd-s">
<code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--scenario</code><code class="descclassname"> &lt;scenario&gt;</code></dt>
<dd><p>YAML scenario file path - Optional if <cite>BCD_SCENARIO</cite> environment variable is defined.</p>
<dd><p>YAML scenario file path - <strong>Only Optional</strong> if <cite>BCD_SCENARIO</cite> environment variable is defined.</p>
</dd></dl>
<dl class="option">
......
......@@ -5,15 +5,14 @@ The BCD controller image provides a ready-to-use environment to launch Bonita Co
## Installation
A pre-built BCD controller image is provided with BCD deliverable as a `bcd-controller_<version>.tar.zip` archive. It is located in the `bonita-continuous-delivery_<version>/docker` directory.
Since BCD 3.0.0, BCD controller image is provided throw Quay.io Registry.
Load this image into Docker engine as follows:
Get this image as follows:
```
$ cd bonita-continuous-delivery_<version>/docker
$ unzip bcd-controller_<version>.tar.zip
$ docker load -i bcd-controller_<version>.tar
Loaded image: bonitasoft/bcd-controller:<version>
Loaded image: bonitasoft/bcd-controller:latest
docker login quay.io
Username: myusername
Password: mypassword
docker pull quay.io/bonitasoft/bcd-controller
```
......@@ -43,16 +42,17 @@ Once the required files are prepared, the BCD controller container can be starte
### Starting a BCD controller with `docker run`
The first method to start a BCD Controller Docker container on the control host is to use the `docker run` command.
The first method to start a BCD Controller Docker container on the control host is to use the `docker run` command with BCD dependencies already present in your host, see [Common Installation Steps](getting_started.md#toc1).
**Example**:
```
$ docker run --rm -t -i --name bcd-controller \
-v bcd-dependencies-<bonita_version>:/home/bonita/bonita-continuous-delivery/dependencies/<bonita_version> \
-v <host_path_to_.boto>:/home/bonita/.boto \
-v <host_path_to_bonita-continuous-delivery_folder>:/home/bonita/bonita-continuous-delivery \
-v <host_path_to_ssh_private_key>:/home/bonita/.ssh/<ssh_private_key> \
bonitasoft/bcd-controller /bin/bash
quay.io/bonitasoft/bcd-controller /bin/bash
```
......
......@@ -57,7 +57,7 @@ Here is a complete example using the configuration files provided.
This example uses an insecure private key. See [more](https://www.vagrantup.com/docs/vagrantfile/ssh_settings.html)...
:::
Assuming you have a `bonita-continuous-delivery_2.0.0` directory in your `$HOME` directory.
Assuming you have a `bonita-continuous-delivery_3.0.0` directory in your `$HOME` directory.
#### 1. Prepare and start your target virtual machine
......@@ -65,7 +65,7 @@ This step will create and configure a single virtual machine with an IP **192.16
On your host machine:
```bash
$ cd $HOME/bonita-continuous-delivery_2.0.0/vagrant/1-machine/
$ cd $HOME/bonita-continuous-delivery_3.0.0/vagrant/1-machine/
$ vagrant up
Bringing machine 'bonita-stack' up with 'virtualbox' provider...
......@@ -84,9 +84,9 @@ Copy the **vagrant_single.yml.EXAMPLE** to a **scenarios/vagrant_single.yml** fi
```bash
$ docker run --rm -ti --hostname bcd-controller --name bcd-controller \
-v ~/bonita-continuous-delivery_2.0.0:/home/bonita/bonita-continuous-delivery \
-v ~/bonita-continuous-delivery_3.0.0:/home/bonita/bonita-continuous-delivery \
-v ~/.vagrant.d/insecure_private_key:/home/bonita/.vagrant.d/insecure_private_key \
bonitasoft/bcd-controller /bin/bash
quay.io/bonitasoft/bcd-controller /bin/bash
bonita@bcd-controller:~$ cd bonita-continuous-delivery
bonita@bcd-controller:~/bonita-continuous-delivery$
bonita@bcd-controller:~/bonita-continuous-delivery$bcd -s scenarios/vagrant_single.yml stack deploy
......
......@@ -81,10 +81,10 @@ Click on **Add Docker template** to add a Docker template in the Docker cloud an
* **Labels**: `bcd`
* **Enabled**: `[checked]`
* **Name**: `bcd`
* **Docker Image**: `bonitasoft/bcd-controller:2.0.1` (where 2.0.1 is the version of BCD to use)
* **Docker Image**: `quay.io/bonitasoft/bcd-controller:3.0.0` (where 3.0.0 is the version of BCD to use)
* **Volumes**:
```
/home/dockeruser/bonita-continuous-delivery_2.0.1:/home/bonita/bonita-continuous-delivery
/home/dockeruser/bonita-continuous-delivery_3.0.0:/home/bonita/bonita-continuous-delivery
/home/dockeruser/.ssh:/home/bonita/.ssh
```
* **Environment**: `ANSIBLE_FORCE_COLOR=true` (this forces colored output in BCD logs)
......
......@@ -28,7 +28,9 @@ This step creates a `bonita-continuous-delivery/bonita-vacation-management-examp
### 2. Provide the repository's build dependencies
The next step is to provide all dependencies required to build your repository. Hence the following artifatcs must be present in the `bonita-continuous-delivery/dependencies` directory:
The next step is to provide all dependencies required to build your repository, see [Common Installation Steps](getting_started.md#toc1).
Hence the following artifacts must be present in the `$BCD_HOME/dependencies/<bonita_version>` directory:
**`bonita-la-builder-<bonita_version>-exec.jar`**
The Bonita Living Application Builder library. Its version must correspond to the **`bonita_version`** variable defined in your BCD scenario. This is the version of the Bonita stack where generated artifacts will be deployed.
......@@ -71,11 +73,11 @@ The `bcd livingapp build` command does not allow to migrate your repository to t
## Complete example
Here is a complete example of how to build the [Bonita Vacation Management example repository](https://github.com/bonitasoft/bonita-vacation-management-example) for Bonita version 7.8.0.
In this example, the REST API extension has a dependency on Bonita 7.6.3.
In this example, the REST API extension has a dependency on Bonita 7.7.0.
**On the control host**
```
$ cd bonita-continuous-delivery_2.0.0
$ cd bonita-continuous-delivery_3.0.0
$ git clone https://github.com/bonitasoft/bonita-vacation-management-example
$ ls -nh bonita-vacation-management-example
......@@ -99,11 +101,24 @@ drwxrwxr-x 2 1000 1000 4,0K Mar 29 16:17 xsd
$ grep "<bonita.version>" bonita-vacation-management-example/restAPIExtensions/tahitiRestApiExtension/pom.xml
<bonita.version>7.6.3</bonita.version>
$ ls -nh dependencies
total 94M
-rw-r--r-- 1 1000 1000 85M Mar 29 12:00 bonita-la-builder-7.8.0-exec.jar
-rw-rw-r-- 1 1000 1000 8,7M Mar 29 16:16 bonita-sp-7.6.3-maven-repository.zip
-rw-r--r-- 1 1000 1000 157 Mar 29 11:57 README.md
$ ls -nhR dependencies/
dependencies/:
total 8
drwxr-xr-x 2 1000 1000 4.0K Nov 22 16:54 7.7.0
drwxr-xr-x 2 1000 1000 4.0K Nov 22 16:52 7.8.0
dependencies/7.7.0:
total 121472
-rw-r--r-- 1 1000 1000 297 Nov 14 11:29 LICENSE
-rw-r--r-- 1 1000 1000 84.5M Nov 14 11:29 bonita-la-builder-7.7.0-exec.jar
-rw-r--r-- 1 1000 1000 34.2M Nov 14 11:29 bonita-sp-7.7.0-maven-repository.zip
dependencies/7.8.0:
total 106096
-rw-r--r-- 1 1000 1000 297 Nov 13 14:03 LICENSE
-rw-r--r-- 1 1000 1000 84.4M Nov 13 14:03 bonita-la-builder-7.8.0.beta-01-exec.jar
-rw-r--r-- 1 1000 1000 19.2M Nov 13 14:03 bonita-sp-7.8.0.beta-01-maven-repository.zip
$ grep "bonita_version" scenarios/euwest1_performance.yml
bonita_version: 7.8.0
......
......@@ -75,6 +75,7 @@ This compatibility information is also specified in the [Release notes](release_
| BCD version | Bonita release |
|-------------|----------------|
| 2.0.x | 7.7.x |
| 3.0.x | < 7.7.x |
</div>
......
......@@ -88,5 +88,5 @@ $ docker run --rm -t -i --name bcd-controller \
-v <host_path_to_bonita-continuous-delivery_folder>:/home/bonita/bonita-continuous-delivery \
-v <host_path_to_ssh_private_key>:/home/bonita/.ssh/<ssh_private_key> \
-v <host_path_to_your_ansible_log>:/var/log/ansible.log \
bonitasoft/bcd-controller /bin/bash
quay.io/bonitasoft/bcd-controller /bin/bash
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment