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

feat(rn): release notes 3.0.0 (#108)

parent 5ae3f5a6
......@@ -23,7 +23,7 @@ Follow these installation steps on your control host.
$ unzip bonita-continuous-delivery_<version>.zip
This step creates a `bonita-continuous-delivery_<version>` directory which contains Bonita Continuous Delivery Ansible playbooks and roles.
3. Pull the `quay.io/bonitasoft/bcd-controller:<version>` Docker image from Bonita private registry:
3. Pull the `quay.io/bonitasoft/bcd-controller:<version>` Docker image from secured registry:
$ docker login quay.io
$ docker pull quay.io/bonitasoft/bcd-controller:<version>
......
......@@ -4,12 +4,12 @@
The following changes introduce incompatibility with BCD 2.x:
* By default, BCD no longer retrieves its dependencies from the filesystem but uses a private Docker registry. So the following variables must be added to your scenarios:
```
bcd_registry_user: YOUR_USER_TO_BCD_DOCKER_REGISTRY
bcd_registry_password: YOUR_PASS_TO_BCD_DOCKER_REGISTRY
```
As a BCD customer, contact your sales representative to get your access to the private registry.
* By default, BCD no longer retrieves its dependencies from the filesystem but uses a secured public Docker registry. So the following variables must be added to your scenarios:
```
bcd_registry_user: YOUR_USER_TO_BCD_DOCKER_REGISTRY
bcd_registry_password: YOUR_PASS_TO_BCD_DOCKER_REGISTRY
```
As a BCD customer, contact your sales representative to get your access to the secured registry.
## Limitations and known issues
......@@ -19,22 +19,16 @@ As a BCD customer, contact your sales representative to get your access to the p
[WARNING]: Could not match supplied host pattern, ignoring: load_balancer
```
## What's new in 3.0.0 (2018-12-)
## What's new in 3.0.0 (2018-12-06)
### New features
* Manage Docker dependencies through a private registry
* Manage [Living Apps Configuration](livingapp_manage_configuration.md) with BCD sub-commands (`bcd livingapp [extract-conf,merge-conf]`)
* Manage Docker dependencies through a secured public registry
* [Manage Bonita licenses](manage_bonita_licenses.md) with BCD sub-commands (`bcd license [generate,revoke]`)
* [Manage Living Apps Configuration](livingapp_manage_configuration.md) with BCD sub-commands (`bcd livingapp [extract-conf,merge-conf]`)
* Create and delete Microsoft Azure resources for the Bonita stack automatically (`bcd_provider: azure`)
### Enhancements
* Enabling endpoint heuristics to guess endpoints for AWS regions that aren’t integrated yet into [boto](http://docs.pythonboto.org). For example, BCD can now manage the AWS region eu-west-3 (Paris) despite the issue [#3783](https://github.com/boto/boto/issues/3783) is still opened.
### Technology updates
*
### Bugfixes
*
* The `bonita_edition` variable is no longer used and it will be ignored if it is still defined in scenarios. The Bonita edition is automatically inferred from your subscription.
......@@ -23,8 +23,8 @@ These are general variables used while provisioning your platform.
| bcd_provider | Y | - | Infrastructure provider. Choose between `aws`, `azure` and `static_inventory`. With `aws` and `azure` providers, BCD may create and destroy infrastructure resources of the Bonita stack. | aws |
| bcd_stack_id | Y | - | Bonita stack identifier used to group machines by stack membership. For AWS deployments the characters allowed are limited to letters, numbers and underscore. | uswest2_test |
| bcd_inventory | N | - | Ansible inventory path required when `bcd_provider` is `static_inventory`. Example static inventories are provided in the `ansible/inventory/vagrant` directory. | ansible/inventory/vagrant/1-machine/inventory |
| bcd_registry_user | Y | - | Docker registry username to pull Bonita images from. Provided by Bonitasoft for BCD private registry. | bonitasoft+john_doe_at_acme_com |
| bcd_registry_password | Y | - | Docker registry password to pull Bonita images from. Provided by Bonitasoft for BCD private registry. | 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCDEFGHIJKLMNOPQR |
| bcd_registry_user | Y | - | Docker registry username to pull Bonita images from. Provided by Bonitasoft for BCD secured registry. | bonitasoft+john_doe_at_acme_com |
| bcd_registry_password | Y | - | Docker registry password to pull Bonita images from. Provided by Bonitasoft for BCD secured registry. | 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCDEFGHIJKLMNOPQR |
| bonita_on_single_host | N | false | Set to `True` when all containers of the Bonita stack is deployed on a single host. | true |
| configuration | Y | - | Configuration filename used to group variables for common deployment types. The corresponding YAML file must exist in the `ansible/vars` directory. | aws_vars |
| ansible_ssh_user | N | ubuntu | SSH user used to connect to target hosts. | ubuntu |
......
......@@ -26,31 +26,31 @@ Please follow the previous documentation describing the [upgrade from 1.0 toward
#### Scenarios
You will first need to copy the files
First, you will need to copy the files:
```
cp bonita-continuous-delivery_2.1.0/scenarios/*.yml bonita-continuous-delivery_${varVersion}.0/scenarios/
$ cp bonita-continuous-delivery_2.1.0/scenarios/*.yml bonita-continuous-delivery_${varVersion}.0/scenarios/
```
Then you will have to check `Breaking changes` section in the [Release Notes](release_notes.md). Indeed you will have to had the new parameters `bcd_registry_user` and `bcd_registry_password` in order to retrieves the BCD dependencies from a private docker registry.
Then you will have to check `Breaking changes` section in the [release notes](release_notes.md). Indeed you will have to add the new variables `bcd_registry_user` and `bcd_registry_password` in order to retrieve BCD dependencies from Bonita secured Docker registry.
Besides, the `bonita_edition` variable has been deprecated in BCD 3.0.0 (read [BCD 3.0.0 Release Notes](release_notes.md) for further details).
Therefore you may remove this variable from your scenario files as it will be ignored.
#### Terraform
Copy the directory corresponding to your stack.
Copy the directory corresponding to your stack:
```
cp -r bonita-continuous-delivery_2.1.0/terraform/your_stack_name bonita-continuous-delivery_${varVersion}.0/terraform/
$ cp -r bonita-continuous-delivery_2.1.0/terraform/your_stack_name bonita-continuous-delivery_${varVersion}.0/terraform/
```
#### BCD controller
As is described in the "Installation guide" from the [Getting started](getting_started.md) you will need to load the last version of `bcd-controller_<version>.tar.zip Docker image.
You can also directly use the private Docker registry to retrive the latest image.
As is described in the "Installation guide" from the [Getting started](getting_started.md) you will need to load the last version of `bcd-controller_<version>.tar.zip Docker image.
You can also directly use the secured Docker registry to retrieve the latest image.
```
docker login quay.io
$ docker login quay.io
Username: myusername
Password: mypassword
docker pull quay.io/bonitasoft/bcd-controller
$ docker pull quay.io/bonitasoft/bcd-controller
```
#### Vagrant
......@@ -59,8 +59,8 @@ As the controller access to them over the network it's not necessary to move the
But if you plan to cleanup the old directory you can moved the vagrant data located inside `1-machine` or `2-machines` directories by copying the `.vagrant` subdirectories.
```
cp -r bonita-continuous-delivery_2.1.0/vagrant/1-machine/.vagrant bonita-continuous-delivery_${varVersion}.0/vagrant/1-machine/
cp -r bonita-continuous-delivery_2.1.0/vagrant/2-machines/.vagrant bonita-continuous-delivery_${varVersion}.0/vagrant/2-machines/
$ cp -r bonita-continuous-delivery_2.1.0/vagrant/1-machine/.vagrant bonita-continuous-delivery_${varVersion}.0/vagrant/1-machine/
$ cp -r bonita-continuous-delivery_2.1.0/vagrant/2-machines/.vagrant bonita-continuous-delivery_${varVersion}.0/vagrant/2-machines/
```
#### Living Application repositories
......@@ -69,5 +69,5 @@ Move the directories where you have cloned your repositories.
For example :
```
cp -r bonita-continuous-delivery_2.1.0/bonita-vacation-management-example bonita-continuous-delivery_${varVersion}.0/bonita-vacation-management-example
$ cp -r bonita-continuous-delivery_2.1.0/bonita-vacation-management-example bonita-continuous-delivery_${varVersion}.0/bonita-vacation-management-example
```
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