From 6447858b8391074184a409f64ec7423f4e0015e5 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Tue, 7 Jun 2022 15:02:27 -0400 Subject: [PATCH] Update code to use the "docker compose" syntax vice "docker-compose" The "docker compose" syntax is the preferred (and only correct) syntax after the changes in cisagov/ansible-role-docker#60. --- ansible/roles/client_cert_update/tasks/main.yml | 2 +- ansible/roles/code_gov_update/tasks/main.yml | 2 +- ansible/roles/cyhy_mailer/tasks/main.yml | 14 +++++++------- ansible/roles/orchestrator/tasks/main.yml | 2 +- ansible/roles/vdp_scanner/tasks/main.yml | 2 +- terraform/README.md | 4 ++-- terraform/variables.tf | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/ansible/roles/client_cert_update/tasks/main.yml b/ansible/roles/client_cert_update/tasks/main.yml index 4bd630121..49cb2a01f 100644 --- a/ansible/roles/client_cert_update/tasks/main.yml +++ b/ansible/roles/client_cert_update/tasks/main.yml @@ -54,5 +54,5 @@ hour: '5' weekday: '2' user: cyhy - job: cd /var/cyhy/client-cert-update && docker-compose up -d 2>&1 | /usr/bin/logger -t client-cert-update + job: cd /var/cyhy/client-cert-update && docker compose up -d 2>&1 | /usr/bin/logger -t client-cert-update when: production_workspace|bool diff --git a/ansible/roles/code_gov_update/tasks/main.yml b/ansible/roles/code_gov_update/tasks/main.yml index b2bc9189e..6042c35f0 100644 --- a/ansible/roles/code_gov_update/tasks/main.yml +++ b/ansible/roles/code_gov_update/tasks/main.yml @@ -74,5 +74,5 @@ hour: '0' weekday: '5' user: cyhy - job: cd /var/cyhy/code-gov-update && docker-compose up -d 2>&1 | /usr/bin/logger -t code-gov-update + job: cd /var/cyhy/code-gov-update && docker compose up -d 2>&1 | /usr/bin/logger -t code-gov-update when: production_workspace|bool diff --git a/ansible/roles/cyhy_mailer/tasks/main.yml b/ansible/roles/cyhy_mailer/tasks/main.yml index e6bc3dc29..375ddf485 100644 --- a/ansible/roles/cyhy_mailer/tasks/main.yml +++ b/ansible/roles/cyhy_mailer/tasks/main.yml @@ -5,9 +5,9 @@ # cyhy-mailer secrets # # The cyhy-mailer container does not run as root, so the creds files -# need to be globally readable. docker-compose does allow one to -# specify the uid, gid, and mode of the secrets files, but that only -# works in swarm mode. +# need to be globally readable. The Docker composition does allow one +# to specify the uid, gid, and mode of the secrets files, but that +# only works in swarm mode. # - name: Create the secrets directory for cyhy-mailer file: @@ -41,13 +41,13 @@ region = {{ ses_aws_region }} role_arn = {{ ses_send_email_role }} -# docker-compose will automatically use docker-compose.yml and +# docker compose will automatically use docker-compose.yml and # docker-compose.override.yml, so this is a way for us to tune -# docker-compose's behavior to the particular machine. +# docker compose's behavior to the particular machine. # # In our case we want to send the BOD 18-01 reports on the BOD docker # instance and the CyHy-related reports on the reporter instance. -- name: Create a symlink for the docker-compose override file +- name: Create a symlink for the docker compose override file file: src: /var/cyhy/cyhy-mailer/{{ docker_compose_override_file_for_mailer }} path: /var/cyhy/cyhy-mailer/docker-compose.override.yml @@ -74,5 +74,5 @@ # hour: 12 # weekday: 1 # user: cyhy -# job: cd /var/cyhy/cyhy-mailer && docker-compose up -d 2>&1 | /usr/bin/logger -t cyhy-mailer +# job: cd /var/cyhy/cyhy-mailer && docker compose up -d 2>&1 | /usr/bin/logger -t cyhy-mailer # when: production_workspace diff --git a/ansible/roles/orchestrator/tasks/main.yml b/ansible/roles/orchestrator/tasks/main.yml index ce7f3188e..cfdda0def 100644 --- a/ansible/roles/orchestrator/tasks/main.yml +++ b/ansible/roles/orchestrator/tasks/main.yml @@ -84,5 +84,5 @@ hour: '0' weekday: '6' user: cyhy - job: cd /var/cyhy/orchestrator && docker-compose up -d 2>&1 | /usr/bin/logger -t orchestrator + job: cd /var/cyhy/orchestrator && docker compose up -d 2>&1 | /usr/bin/logger -t orchestrator when: production_workspace|bool diff --git a/ansible/roles/vdp_scanner/tasks/main.yml b/ansible/roles/vdp_scanner/tasks/main.yml index 78ac61c40..286f58052 100644 --- a/ansible/roles/vdp_scanner/tasks/main.yml +++ b/ansible/roles/vdp_scanner/tasks/main.yml @@ -11,5 +11,5 @@ hour: '0' weekday: '1' user: cyhy - job: cd /var/cyhy/vdp && docker-compose up -d 2>&1 | /usr/bin/logger -t vdp-scanner + job: cd /var/cyhy/vdp && docker compose up -d 2>&1 | /usr/bin/logger -t vdp-scanner when: production_workspace|bool diff --git a/terraform/README.md b/terraform/README.md index 5f799d2c5..e23678dd0 100644 --- a/terraform/README.md +++ b/terraform/README.md @@ -650,7 +650,7 @@ terraform apply -var-file=.tfvars | cyhy\_vulnscan\_first\_elastic\_ip\_offset | The offset of the address (from the start of the elastic IP CIDR block) to be assigned to the *first* CyHy vulnscan instance. For example, if the CIDR block is 192.168.1.0/24 and the offset is set to 10, the first vulnscan address used will be 192.168.1.10. This is only used in production workspaces. Each additional vulnscan instance will get the next consecutive address in the block. NOTE: This will only work as intended when a contiguous CIDR block of EIP addresses is available. | `number` | `1` | no | | dmarc\_import\_aws\_region | The AWS region where the dmarc-import Elasticsearch database resides. | `string` | `"us-east-1"` | no | | dmarc\_import\_es\_role\_arn | The ARN of the role that must be assumed in order to read the dmarc-import Elasticsearch database. | `string` | n/a | yes | -| docker\_mailer\_override\_filename | This file is used to add/override any docker-compose settings for cyhy-mailer for the docker EC2 instance. It must already exist in /var/cyhy/cyhy-mailer. | `string` | `"docker-compose.bod.yml"` | no | +| docker\_mailer\_override\_filename | This file is used to add/override any Docker composition settings for cyhy-mailer for the docker EC2 instance. It must already exist in /var/cyhy/cyhy-mailer. | `string` | `"docker-compose.bod.yml"` | no | | enable\_mgmt\_vpc | Whether or not to enable unfettered access from the vulnerability scanner in the Management VPC to other VPCs (CyHy, BOD). This should only be enabled while running security scans from the Management VPC. | `bool` | `false` | no | | findings\_data\_field\_map | The key for the file storing field name mappings in JSON format. | `string` | n/a | yes | | findings\_data\_import\_db\_hostname | The hostname that has the database to store the findings data in. | `string` | `""` | no | @@ -678,7 +678,7 @@ terraform apply -var-file=.tfvars | nmap\_cyhy\_runner\_disk | The cyhy-runner data volume for the Nmap instance(s). | `string` | `"/dev/nvme1n1"` | no | | nmap\_instance\_count | The number of Nmap instances to create. | `number` | n/a | yes | | remote\_ssh\_user | The username to use when sshing to the EC2 instances. | `string` | n/a | yes | -| reporter\_mailer\_override\_filename | This file is used to add/override any docker-compose settings for cyhy-mailer for the reporter EC2 instance. It must already exist in /var/cyhy/cyhy-mailer. | `string` | `"docker-compose.cyhy.yml"` | no | +| reporter\_mailer\_override\_filename | This file is used to add/override any Docker composition settings for cyhy-mailer for the reporter EC2 instance. It must already exist in /var/cyhy/cyhy-mailer. | `string` | `"docker-compose.cyhy.yml"` | no | | scan\_types | The scan types that can be run. | `list(string)` | n/a | yes | | ses\_aws\_region | The AWS region where SES is configured. | `string` | `"us-east-1"` | no | | ses\_role\_arn | The ARN of the role that must be assumed in order to send emails. | `string` | n/a | yes | diff --git a/terraform/variables.tf b/terraform/variables.tf index 336793450..b73305ded 100644 --- a/terraform/variables.tf +++ b/terraform/variables.tf @@ -226,7 +226,7 @@ variable "dmarc_import_aws_region" { variable "docker_mailer_override_filename" { default = "docker-compose.bod.yml" - description = "This file is used to add/override any docker-compose settings for cyhy-mailer for the docker EC2 instance. It must already exist in /var/cyhy/cyhy-mailer." + description = "This file is used to add/override any Docker composition settings for cyhy-mailer for the docker EC2 instance. It must already exist in /var/cyhy/cyhy-mailer." type = string } @@ -338,7 +338,7 @@ variable "nmap_cyhy_runner_disk" { variable "reporter_mailer_override_filename" { default = "docker-compose.cyhy.yml" - description = "This file is used to add/override any docker-compose settings for cyhy-mailer for the reporter EC2 instance. It must already exist in /var/cyhy/cyhy-mailer." + description = "This file is used to add/override any Docker composition settings for cyhy-mailer for the reporter EC2 instance. It must already exist in /var/cyhy/cyhy-mailer." type = string }