From 6ca9cb7b6af03dc5c198f39b97bab6804c57f5e7 Mon Sep 17 00:00:00 2001 From: Lucas Rodriguez Date: Thu, 26 Oct 2023 16:49:03 -0500 Subject: [PATCH] Update README.md to use yaml config file --- README.md | 60 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index a224abd..93e8a0f 100644 --- a/README.md +++ b/README.md @@ -54,28 +54,31 @@ zarf package pull oci://ghcr.io/defenseunicorns/packages/init-aws:v0.0.1-amd64 #### Use ***private*** ECR registry -1. Create a Zarf config file `zarf-config.toml` +1. Create a Zarf config file `zarf-config.yaml` - ```toml - architecture = 'amd64' + ```yaml + architecture: amd64 - [package.deploy] - components = 'zarf-ecr-credential-helper' + package: + deploy: + components: zarf-ecr-credential-helper - [package.deploy.set] - registry_type = 'private' + package: + deploy: + set: + registry_type: private - # Change me to your AWS region if needed - aws_region = 'us-east-1' + # Change me to your AWS region if needed + aws_region: us-east-1 - # Set IAM role ARNs - ecr_hook_role_arn = '' - ecr_credential_helper_role_arn = '' + # Set IAM role ARNs + ecr_hook_role_arn: + ecr_credential_helper_role_arn: ``` 1. Zarf init - Note: Be sure to run the `zarf init` command from the same working directory as your Zarf config file + Note: Be sure to run the `zarf init` command from the same working directory as your Zarf config file or set the `ZARF_CONFIG` environment variable to point to your config file. ```bash AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query 'Account' --output text) @@ -90,29 +93,32 @@ zarf package pull oci://ghcr.io/defenseunicorns/packages/init-aws:v0.0.1-amd64 #### Use ***public*** ECR registry -1. Create a Zarf config file `zarf-config.toml` +1. Create a Zarf config file `zarf-config.yaml` - ```toml - architecture = 'amd64' + ```yaml + architecture: amd64 - [package.deploy] - components = 'zarf-ecr-credential-helper' + package: + deploy: + components: zarf-ecr-credential-helper - [package.deploy.set] - registry_type = 'public' + package: + deploy: + set: + registry_type: public - # Must use us-east-1 region for public ECR registries: - # https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth - aws_region = 'us-east-1' + # Must use us-east-1 region for public ECR registries + # https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth + aws_region: us-east-1 - # Set IAM role ARNs - ecr_hook_role_arn = '' - ecr_credential_helper_role_arn = '' + # Set IAM role ARNs + ecr_hook_role_arn: + ecr_credential_helper_role_arn: ``` 1. Zarf init - Note: Be sure to run the `zarf init` command from the same working directory as your Zarf config file + Note: Be sure to run the `zarf init` command from the same working directory as your Zarf config file or set the `ZARF_CONFIG` environment variable to point to your config file. ```bash zarf init \