Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update plugins doc with the correct _SKIP_DEPLOY ENV vars #354

Merged
merged 5 commits into from
Nov 14, 2022
Merged

Update plugins doc with the correct _SKIP_DEPLOY ENV vars #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa5d39e
Updating terraform doc
PhillypHenning Nov 10, 2022
b44f04f
Updating plugin doc to support the SKIP updates
PhillypHenning Nov 10, 2022
6291ac3
Updating Ansible plugin docs
PhillypHenning Nov 10, 2022
b248fcf
Updating CFN doc
PhillypHenning Nov 10, 2022
dde2fde
HELM_SKIP_DEPLOY
PhillypHenning Nov 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/development-local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ docker run --rm --name bitops \
-e AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" \
-e BITOPS_ENVIRONMENT="prod" \
-e BITOPS_ENVIRONMENT_HELM_SUBDIRECTORY="aws-auth" \
-e SKIP_DEPLOY_TERRAFORM="true" \
-e SKIP_DEPLOY_HELM="" \
-e TERRAFORM_SKIP_DEPLOY="true" \
-e HELM_SKIP_DEPLOY="" \
-e DEFAULT_FOLDER_NAME="_default" \
-v /path/to/operations-repo:/opt/bitops_deployment \
-v /path/to/bitops:/opt/bitops \
Expand All @@ -65,7 +65,7 @@ bitovi/bitops:2.1.0
| -e AWS_ACCESS_KEY_ID="\${AWS_ACCESS_KEY_ID}" \ <br/> -e AWS_SECRET_ACCESS_KEY="\${AWS_SECRET_ACCESS_KEY}" \ <br/> -e AWS_SESSION_TOKEN="\${AWS_SESSION_TOKEN}" \ | AWS credentials/config|
| `-e BITOPS_ENVIRONMENT="prod" \` | Set the BitOps environment to deploy (in this example, prod) |
| `-e BITOPS_ENVIRONMENT_HELM_SUBDIRECTORY="aws-auth" \` | Set the specific Helm chart to deploy (in this example, aws-auth). | This is quite useful for iterating quickly if you’ve got an ops repo environment with many Helm charts but only want to focus on a single one. |
| -e SKIP_DEPLOY_TERRAFORM="true" \ <br/> -e SKIP_DEPLOY_HELM="" \ | Skip the Terraform deployment but not the Helm deployment (you could also omit SKIP_DEPLOY_HELM). | This is useful if you want to deploy only a single tool in the environment. |
| -e TERRAFORM_SKIP_DEPLOY="true" \ <br/> -e HELM_SKIP_DEPLOY="" \ | Skip the Terraform deployment but not the Helm deployment (you could also omit HELM_SKIP_DEPLOY). | This is useful if you want to deploy only a single tool in the environment. |
| `-e DEFAULT_FOLDER_NAME="_default" \` | Define the directory to pull defaults from. Default should be _default, so this could be omitted if your default environment is _default. |
| -v /path/to/operations-repo:/opt/bitops_deployment \ | Mount your local operations repo to the location BitOps expects it to be. |
| -v /path/to/bitops:/opt/bitops \ | Mount your local BitOps repo to the location BitOps expects it to be (i.e. /opt/bitops). This way, you can make changes to the BitOps code locally, and changes will be reflected when you run the docker run command. |
Expand Down
4 changes: 2 additions & 2 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ bitovi/bitops:latest
```

### Force skip over ansible
If there is a `./dev/ansible/` directory, ansible execution can be skipped with `SKIP_DEPLOY_ANSIBLE=true`:
If there is a `./dev/ansible/` directory, ansible execution can be skipped with `ANSIBLE_SKIP_DEPLOY=true`:
```
docker run \
-e BITOPS_ENVIRONMENT="dev" \
-e AWS_ACCESS_KEY_ID=<AWS_SECRET_ACCESS_KEY> \
-e AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY> \
-e AWS_DEFAULT_REGION="us-east-1" \
-e SKIP_DEPLOY_ANSIBLE=true \
-e ANSIBLE_SKIP_DEPLOY=true \
-v $(pwd):/opt/bitops_deployment \
bitovi/bitops:latest
```
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/bitops+fast+react+static+renderer/_scripts/deploy/deploy.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ docker run --rm --name bitops \
-e AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" \
-e ENVIRONMENT="${ENVIRONMENT}" \
-e ENVIRONMENT_HELM_SUBDIRECTORY="${ENVIRONMENT_HELM_SUBDIRECTORY}" \
-e SKIP_DEPLOY_TERRAFORM="${SKIP_DEPLOY_TERRAFORM}" \
-e SKIP_DEPLOY_HELM="${SKIP_DEPLOY_HELM}" \
-e TERRAFORM_SKIP_DEPLOY="${TERRAFORM_SKIP_DEPLOY}" \
-e HELM_SKIP_DEPLOY="${HELM_SKIP_DEPLOY}" \
-e TF_STATE_BUCKET="${TF_STATE_BUCKET}" \
-e KUBECONFIG_BASE64="$KUBECONFIG_BASE64" \
-e PROVIDERS="$PROVIDERS" \
Expand Down
2 changes: 1 addition & 1 deletion docs/tool-configuration/configuration-ansible.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Although not captured in `bitops.config.yaml`, the following environment variabl
| Environmental Variable | Description |
| ---------------------- | ------------------------------------------------------------ |
| EXTRA_ENV | Before Ansible playbook execution, BitOps will look for an `extra_env` file containing additional environment parameters (`FOO=val1`) in the Ansible plugin directory. If found, the values will be exported to the BitOps environment. |
| SKIP_DEPLOY_ANSIBLE | Will skip all ansible executions. This supersedes all other configurations. |
| ANSIBLE_SKIP_DEPLOY | Will skip all ansible executions. This supersedes all other configurations. |



2 changes: 1 addition & 1 deletion docs/tool-configuration/configuration-cloudformation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ Although not captured in `bitops.config.yaml`, the following environment variabl
-------------------
| Environmental Variable | Description |
| -------------------------- | ------------------------------------------------------------ |
| SKIP_DEPLOY_CLOUDFORMATION | Will skill all CloudFormation executions. This supersedes all other configuration |
| CFN_SKIP_DEPLOY | Will skill all CloudFormation executions. This supersedes all other configuration |

4 changes: 2 additions & 2 deletions docs/tool-configuration/configuration-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ helm:

| Property | Environment Variable | Description | Default | Required |
| ----------------------------- | -------------------- | ------------------------------------------------------------ | ------- | -------- |
| skip-deploy | SKIP_DEPLOY | Will skip helm execution | `null` | |
| skip-deploy | HELM_SKIP_DEPLOY | Will skip helm execution | `null` | |
| release-name | HELM_RELEASE_NAME | Sets helm release name | `null` | |
| uninstall | HELM_UNINSTALL | If true, this chart will be uninstalled instead of deployed/upgraded. If the environment variable `HELM_UNINSTALL` is passed into the container, all BitOps-managed charts for a given environment will be uninstalled. | `null` | |
| kubeconfig | | configure cluster access. Has the following child-properties. Should provide one of `path` or `fetch`. Defaults to `fetch` | `fetch` | |
Expand Down Expand Up @@ -74,7 +74,7 @@ Although not captured in `bitops.config.yaml`, the following environment variabl

| Environmental Variable | Description |
| ---------------------- | ------------------------------------------------------------ |
| SKIP_DEPLOY_HELM | Will skip all helm executions. This supersedes all other configurations. |
| HELM_SKIP_DEPLOY | Will skip all helm executions. This supersedes all other configurations. |
| HELM_UNINSTALL_CHARTS | Comma-separated string. If any of the charts to be deployed match one of the chart names listed here, it will be uninstalled with `helm uninstall $HELM_RELEASE_NAME` instead of deployed/upgraded. |


Expand Down
3 changes: 2 additions & 1 deletion docs/tool-configuration/configuration-terraform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Run BitOps with the environmental variable `TERRAFORM_APPLY` set to `true` or se
| Property | Environment Variable | Description | Default | Required |
| ------------ | -------------------------- | ------------------------------------------------------------ | ------- | -------- |
| stack-action | BITOPS_TERRAFORM_COMMAND | Controls what terraform command to run. e.g. `apply`, `destroy`, etc. | `plan` | No |
| skip-deploy | TERRAFORM_SKIP_DEPLOY | If set to true, regardless of the stack-action, deployment actions will be skipped. | false | No |
| workspace | BITOPS_TERRAFORM_WORKSPACE | Will select a terraform workspace using `terraform workspace new $TERRAFORM_WORKSPACE ||terraform workspace select $TERRAFORM_WORKSPACE` prior to running other terraform commands. | `null` | No |

-------------------
Expand All @@ -56,7 +57,7 @@ Although not captured in `bitops.config.yaml`, the following environment variabl
-------------------
| Variable | Description |
| --------------------- | ------------------------------------------------------------ |
| SKIP_DEPLOY_TERRAFORM | Will skip all terraform executions. This supersedes all other configurations. |
| TERRAFORM_SKIP_DEPLOY | Will skip all terraform executions. This supersedes all other configurations. |
| TERRAFORM_APPLY | Will force call `terraform apply`. |
| TERRAFORM_DESTROY | Will force call `terraform destroy`. |
| INIT_UPGRADE | Will add `--upgrade` flag to the init command. |
Expand Down