Commit 6d9d31c2 authored by Truc Nguyen's avatar Truc Nguyen
Browse files

tr(scenario): rename test_userid variable to bcd_stack_id (BCD-134)

parent 03443742
......@@ -44,7 +44,7 @@ The classic usage at this very moment is:
- Bonita platform deployment in EC2 or on premises
- (Optional) Amazon EC2 instance deletion
The user must specify the `test_userid` variable **for each command** in order to identify its infrastructure. Multiple tests with different `test_userid` can be used simultaneously even on AWS. The `test_userid` variable should contain only letters, digits or underscore characters (see https://github.com/ansible/ansible/blob/v2.3.1.0-1/contrib/inventory/ec2.py#L1555).
The user must specify the `bcd_stack_id` variable **for each command** in order to identify its infrastructure. Multiple tests with different `bcd_stack_id` can be used simultaneously even on AWS. The `bcd_stack_id` variable should contain only letters, digits or underscore characters (see https://github.com/ansible/ansible/blob/v2.3.1.0-1/contrib/inventory/ec2.py#L1555).
In order to describe a new infrastructure and software configuration (aka. _scenario_), you need to prepare the following files:
- **scenarios/<scenario_name>.yml**: this YAML file should gather all relevant variables which describe the scenario
......@@ -131,7 +131,7 @@ Ansible facts are local variables registered in hosts. It is possible to save th
```
$ ansible all -vv -i inventory/ec2/ec2_wrapper.sh -m setup -u ubuntu --tree tmp_facts/
```
This command will identify every EC2 instance (regardless of `test_userid`) and put its facts into the `tmp_facts` directory.
This command will identify every EC2 instance (regardless of `bcd_stack_id`) and put its facts into the `tmp_facts` directory.
### Dive into the scenarios
For further details see [this section](scenarios.md)
......
# Known issues
- Using '.' or '-' in `test_userid` will cause errors: the created EC2 instances won't be able to be retrieved for stack deployment.
- Using '.' or '-' in `bcd_stack_id` will cause errors: the created EC2 instances won't be able to be retrieved for stack deployment.
- On a BCD controller we can manage only one Terraform stack at a time.
......@@ -4,7 +4,7 @@ With scenarios, you can define your infrastructure, Bonita installation and pote
The format is flat as shows this sample :
```yaml
test_userid: vagrant
bcd_stack_id: vagrant
configuration: vagrant_vars
bonita_cluster_mode: false
bonita_cluster_qty: 1
......@@ -16,7 +16,7 @@ Some parameters are mandatory for general provisioning and test description.
|Name |Mandatory|Default|Description|Sample|
|-|-|-|-|-|
|test_userid|Y| |Id of the test. Used for tests identification and test results export directory|jenkins-test|
|bcd_stack_id|Y| |Id of the test. Used for tests identification and test results export directory|jenkins-test|
|configuration|Y | |Configuration filename. Initialize main variables. Choose between aws_vars, vagrant_vars|aws_vars|
|ansible_ssh_user|N|ubuntu|SSH user|ubuntu|
|ansible_private_key_file|Y |-|Path for the private SSH key.|~/.ssh/jenkins_ansible_us-west-2.pem|
......
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