diff --git a/docs/roles/_init.md b/docs/roles/_init.md index 77feacb1f..4abd58990 100644 --- a/docs/roles/_init.md +++ b/docs/roles/_init.md @@ -15,6 +15,11 @@ _venv_command: /usr/bin/python3 -m venv _venv_install_username: "{{ _ce_provision_username }}" _ce_ansible_timer_name: upgrade_ce_provision_ansible +# AWS variables - if you are using an AWS account, you can preset certain variables +# Generally it is recommended to place these in your ce-provision-config repository under hosts/group_vars/all +#_aws_profile: example # boto profile name +#_aws_region: eu-west-1 + _init: # A list of var directories to include. We only support .yml extensions. # This is used to detect if the playbook must re-run or not. diff --git a/docs/roles/debian/aws_cloudwatch_agent.md b/docs/roles/debian/aws_cloudwatch_agent.md index ee37572c7..cdda9f9b5 100644 --- a/docs/roles/debian/aws_cloudwatch_agent.md +++ b/docs/roles/debian/aws_cloudwatch_agent.md @@ -14,9 +14,9 @@ module in your playbooks. --- aws_cloudwatch_agent: # Stream name. - log_stream_name: "example" + log_stream_name: example # Namespace for metrics. Leave empty to use the default CWAgent. - metrics_namespace: "example" + metrics_namespace: example # Group prefix. Useful for grouping by environments. # Eg. instead of "syslog", you can have "dev syslog", "prod syslog", etc. log_group_prefix: "" @@ -26,7 +26,7 @@ aws_cloudwatch_agent: credentials: aws_access_key_id: XXX aws_secret_access_key: XXX - region: "{{ _aws_region }}" + region: eu-west-1 # AWS region name - can be substituted for "{{ _aws_region }}" if set ``` diff --git a/docs/roles/debian/aws_efs_client.md b/docs/roles/debian/aws_efs_client.md index 6d3cd392d..856fe71ca 100644 --- a/docs/roles/debian/aws_efs_client.md +++ b/docs/roles/debian/aws_efs_client.md @@ -44,8 +44,8 @@ In the output of listed file systems, for each one you will find an entry like t _mount_opts: "_netdev,noresvport" # _netdev tells OS to wait for network before attempting to mount _mount_state: present aws_efs_client: - aws_profile: "{{ _aws_profile }}" - region: "{{ _aws_region }}" + aws_profile: example # AWS boto profile name - can be substituted for "{{ _aws_profile }}" if set + region: eu-west-1 # AWS region name - can be substituted for "{{ _aws_region }}" if set version: 1.35.0 # version of AWS EFS utils to use build_suffix: "-1_all" # sometimes there is a suffix appended to the package name, e.g. `amazon-efs-utils-1.35.0-1_all.deb` deb_url: "" # provide an alternative location for the .deb package diff --git a/docs/roles/debian/duplicity.md b/docs/roles/debian/duplicity.md index 7e4911527..c9140007e 100644 --- a/docs/roles/debian/duplicity.md +++ b/docs/roles/debian/duplicity.md @@ -17,7 +17,7 @@ duplicity: backend: s3 # currently also support b2 for Backblaze access_key_id: "somekey" secret_access_key: "somesecret" - backend_url: "s3-eu-west-1.amazonaws.com" + backend_url: "s3-eu-west-1.amazonaws.com" # "eu-west-1" can be substituted for "{{ _aws_region }}" if set s3_options: "--s3-use-glacier-ir" # see the --s3 options in the documentation - https://duplicity.us/stable/duplicity.1.html#options bucketname: "somebucket" dirs: diff --git a/docs/roles/debian/gitlab_runner.md b/docs/roles/debian/gitlab_runner.md index 2804320b5..7311c5bf0 100644 --- a/docs/roles/debian/gitlab_runner.md +++ b/docs/roles/debian/gitlab_runner.md @@ -49,8 +49,8 @@ gitlab_runner: # see https://gitlab.com/gitlab-org/ci-cd/custom-executor-drivers/fargate/-/tree/master/docs fargate: cluster: "my-cluster" # ECS cluster name - profile: "{{ _aws_profile }}" - region: "eu-west-1" # AWS region name + profile: "example" # AWS boto profile name - can be substituted for "{{ _aws_profile }}" if set + region: "eu-west-1" # AWS region name - can be substituted for "{{ _aws_region }}" if set subnet: "subnet-abcdef123456" # subnet ID security_group: "my-security-group" # SG name task_definition: "my-task:1" # task definition in format name:revision, if revision is not provided ECS will use latest diff --git a/roles/_init/README.md b/roles/_init/README.md index 77feacb1f..4abd58990 100644 --- a/roles/_init/README.md +++ b/roles/_init/README.md @@ -15,6 +15,11 @@ _venv_command: /usr/bin/python3 -m venv _venv_install_username: "{{ _ce_provision_username }}" _ce_ansible_timer_name: upgrade_ce_provision_ansible +# AWS variables - if you are using an AWS account, you can preset certain variables +# Generally it is recommended to place these in your ce-provision-config repository under hosts/group_vars/all +#_aws_profile: example # boto profile name +#_aws_region: eu-west-1 + _init: # A list of var directories to include. We only support .yml extensions. # This is used to detect if the playbook must re-run or not. diff --git a/roles/_init/defaults/main.yml b/roles/_init/defaults/main.yml index d05a6fc78..5e38419ea 100644 --- a/roles/_init/defaults/main.yml +++ b/roles/_init/defaults/main.yml @@ -5,6 +5,11 @@ _venv_command: /usr/bin/python3 -m venv _venv_install_username: "{{ _ce_provision_username }}" _ce_ansible_timer_name: upgrade_ce_provision_ansible +# AWS variables - if you are using an AWS account, you can preset certain variables +# Generally it is recommended to place these in your ce-provision-config repository under hosts/group_vars/all +#_aws_profile: example # boto profile name +#_aws_region: eu-west-1 + _init: # A list of var directories to include. We only support .yml extensions. # This is used to detect if the playbook must re-run or not. diff --git a/roles/debian/aws_cloudwatch_agent/README.md b/roles/debian/aws_cloudwatch_agent/README.md index ee37572c7..cdda9f9b5 100644 --- a/roles/debian/aws_cloudwatch_agent/README.md +++ b/roles/debian/aws_cloudwatch_agent/README.md @@ -14,9 +14,9 @@ module in your playbooks. --- aws_cloudwatch_agent: # Stream name. - log_stream_name: "example" + log_stream_name: example # Namespace for metrics. Leave empty to use the default CWAgent. - metrics_namespace: "example" + metrics_namespace: example # Group prefix. Useful for grouping by environments. # Eg. instead of "syslog", you can have "dev syslog", "prod syslog", etc. log_group_prefix: "" @@ -26,7 +26,7 @@ aws_cloudwatch_agent: credentials: aws_access_key_id: XXX aws_secret_access_key: XXX - region: "{{ _aws_region }}" + region: eu-west-1 # AWS region name - can be substituted for "{{ _aws_region }}" if set ``` diff --git a/roles/debian/aws_cloudwatch_agent/defaults/main.yml b/roles/debian/aws_cloudwatch_agent/defaults/main.yml index f73385114..36d3d3751 100644 --- a/roles/debian/aws_cloudwatch_agent/defaults/main.yml +++ b/roles/debian/aws_cloudwatch_agent/defaults/main.yml @@ -1,9 +1,9 @@ --- aws_cloudwatch_agent: # Stream name. - log_stream_name: "example" + log_stream_name: example # Namespace for metrics. Leave empty to use the default CWAgent. - metrics_namespace: "example" + metrics_namespace: example # Group prefix. Useful for grouping by environments. # Eg. instead of "syslog", you can have "dev syslog", "prod syslog", etc. log_group_prefix: "" @@ -13,4 +13,4 @@ aws_cloudwatch_agent: credentials: aws_access_key_id: XXX aws_secret_access_key: XXX - region: "{{ _aws_region }}" + region: eu-west-1 # AWS region name - can be substituted for "{{ _aws_region }}" if set diff --git a/roles/debian/aws_efs_client/README.md b/roles/debian/aws_efs_client/README.md index 6d3cd392d..856fe71ca 100644 --- a/roles/debian/aws_efs_client/README.md +++ b/roles/debian/aws_efs_client/README.md @@ -44,8 +44,8 @@ In the output of listed file systems, for each one you will find an entry like t _mount_opts: "_netdev,noresvport" # _netdev tells OS to wait for network before attempting to mount _mount_state: present aws_efs_client: - aws_profile: "{{ _aws_profile }}" - region: "{{ _aws_region }}" + aws_profile: example # AWS boto profile name - can be substituted for "{{ _aws_profile }}" if set + region: eu-west-1 # AWS region name - can be substituted for "{{ _aws_region }}" if set version: 1.35.0 # version of AWS EFS utils to use build_suffix: "-1_all" # sometimes there is a suffix appended to the package name, e.g. `amazon-efs-utils-1.35.0-1_all.deb` deb_url: "" # provide an alternative location for the .deb package diff --git a/roles/debian/aws_efs_client/defaults/main.yml b/roles/debian/aws_efs_client/defaults/main.yml index ba81a7629..7758d8820 100644 --- a/roles/debian/aws_efs_client/defaults/main.yml +++ b/roles/debian/aws_efs_client/defaults/main.yml @@ -2,8 +2,8 @@ _mount_opts: "_netdev,noresvport" # _netdev tells OS to wait for network before attempting to mount _mount_state: present aws_efs_client: - aws_profile: "{{ _aws_profile }}" - region: "{{ _aws_region }}" + aws_profile: example # AWS boto profile name - can be substituted for "{{ _aws_profile }}" if set + region: eu-west-1 # AWS region name - can be substituted for "{{ _aws_region }}" if set version: 1.35.0 # version of AWS EFS utils to use build_suffix: "-1_all" # sometimes there is a suffix appended to the package name, e.g. `amazon-efs-utils-1.35.0-1_all.deb` deb_url: "" # provide an alternative location for the .deb package diff --git a/roles/debian/duplicity/README.md b/roles/debian/duplicity/README.md index 7e4911527..c9140007e 100644 --- a/roles/debian/duplicity/README.md +++ b/roles/debian/duplicity/README.md @@ -17,7 +17,7 @@ duplicity: backend: s3 # currently also support b2 for Backblaze access_key_id: "somekey" secret_access_key: "somesecret" - backend_url: "s3-eu-west-1.amazonaws.com" + backend_url: "s3-eu-west-1.amazonaws.com" # "eu-west-1" can be substituted for "{{ _aws_region }}" if set s3_options: "--s3-use-glacier-ir" # see the --s3 options in the documentation - https://duplicity.us/stable/duplicity.1.html#options bucketname: "somebucket" dirs: diff --git a/roles/debian/duplicity/defaults/main.yml b/roles/debian/duplicity/defaults/main.yml index 6d7a6f3d6..33cecfec2 100644 --- a/roles/debian/duplicity/defaults/main.yml +++ b/roles/debian/duplicity/defaults/main.yml @@ -8,7 +8,7 @@ duplicity: backend: s3 # currently also support b2 for Backblaze access_key_id: "somekey" secret_access_key: "somesecret" - backend_url: "s3-eu-west-1.amazonaws.com" + backend_url: "s3-eu-west-1.amazonaws.com" # "eu-west-1" can be substituted for "{{ _aws_region }}" if set s3_options: "--s3-use-glacier-ir" # see the --s3 options in the documentation - https://duplicity.us/stable/duplicity.1.html#options bucketname: "somebucket" dirs: diff --git a/roles/debian/gitlab_runner/README.md b/roles/debian/gitlab_runner/README.md index 2804320b5..7311c5bf0 100644 --- a/roles/debian/gitlab_runner/README.md +++ b/roles/debian/gitlab_runner/README.md @@ -49,8 +49,8 @@ gitlab_runner: # see https://gitlab.com/gitlab-org/ci-cd/custom-executor-drivers/fargate/-/tree/master/docs fargate: cluster: "my-cluster" # ECS cluster name - profile: "{{ _aws_profile }}" - region: "eu-west-1" # AWS region name + profile: "example" # AWS boto profile name - can be substituted for "{{ _aws_profile }}" if set + region: "eu-west-1" # AWS region name - can be substituted for "{{ _aws_region }}" if set subnet: "subnet-abcdef123456" # subnet ID security_group: "my-security-group" # SG name task_definition: "my-task:1" # task definition in format name:revision, if revision is not provided ECS will use latest diff --git a/roles/debian/gitlab_runner/defaults/main.yml b/roles/debian/gitlab_runner/defaults/main.yml index af891d799..1813aa89b 100644 --- a/roles/debian/gitlab_runner/defaults/main.yml +++ b/roles/debian/gitlab_runner/defaults/main.yml @@ -37,8 +37,8 @@ gitlab_runner: # see https://gitlab.com/gitlab-org/ci-cd/custom-executor-drivers/fargate/-/tree/master/docs fargate: cluster: "my-cluster" # ECS cluster name - profile: "{{ _aws_profile }}" - region: "eu-west-1" # AWS region name + profile: "example" # AWS boto profile name - can be substituted for "{{ _aws_profile }}" if set + region: "eu-west-1" # AWS region name - can be substituted for "{{ _aws_region }}" if set subnet: "subnet-abcdef123456" # subnet ID security_group: "my-security-group" # SG name task_definition: "my-task:1" # task definition in format name:revision, if revision is not provided ECS will use latest