Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

add documentation about rollback protection and links to related wiki pages #48

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,7 @@ Simply run `tox` and the following will be executed:
* pyinstaller for packaging dcos-launch

Note: these can be triggered individually by supplying the `-e` option to `tox`

### More docs
- [User guide](./dcos_launch/README.md)
- [Config docs and examples](./dcos_launch/sample_configs/README.md)
23 changes: 23 additions & 0 deletions dcos_launch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,26 @@ Log level. By default, the log level is info. By using this option you will also

### `-e LIST`
Custom environment variables to include. This option allows passing through environment variables from the current environment into the testing environment. The list is comma delimited and any provided environment variables will override the automatically injected ones. Required variables that are automatically injected include `MASTER_HOSTS`, `SLAVE_HOSTS`, `PUBLIC_MASTER_HOSTS`, `PUBLIC_SLAVE_HOSTS`, `DCOS_DNS_ADDRESS`. E.g. `dcos-launch pytest -e MASTER_HOSTS -- test_composition.py`, `ENABLE_RESILIENCY_TESTS=true dcos-launch pytest -e ENABLE_RESILIENCY_TESTS,MASTER_HOSTS -- test_applications.py`

## FAQ

### How can I keep my cluster from being deleted?

By default the AWS-managed clusters will be garbage-collected after 2 hours. You can extend the cluster's life through [CCM](https://ccm.mesosphere.com), but if for some reason this isn't working, you need to enable termination protection manually.

If you know in advance that you want to completely disable cluster termination, you can set the `disable_rollback` parameter in your config file to `true`.

If you have already launched a cluster without rollback protection, you can enable the protection manually.

1. Log into the AWS console through [OneLogin](https://mesosphere.onelogin.com)
2. Go to the CloudFormation console and search for your cluster. The Stack Name will be what you provided for `deployment_name` in the launch config.
3. Click on the stack to view its Stack Detail page. In the upper right hand corner there should be a dropdown button for `Other Actions`. Select `Change termination protection` and enable termination protection.


***Don't forget to delete your cluster!***

If you have enabled termination protection, when you are done with your cluster, disable the termination protection again and then delete it through `dcos-launch delete` or manually through the CloudFormation console

### Can I stop a TeamCity cluster from being deleted?

At this time you cannot prevent TeamCity from deleting a cluster.
1 change: 1 addition & 0 deletions dcos_launch/sample_configs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ _Note_: DC/OS deployed from aws or azure provider do not technically need `ssh_u
### Options
* `key_helper`: generate private SSH keys for the underlying hosts if `true`. In `platform: aws`, this means the user does not have to supply `KeyName` in the template parameters and dcos-launch will fill it in. Similarly, in `platform: azure`, `sshRSAPublicKey` is populated automatically. In the aws case, this key will be deleted from EC2 when the deployment is deleted with dcos-launch
* `zen_helper`: only to be used with `provider: aws` and zen templates. If `true`, then the network prerequisites for launching a zen cluster will be provided if missing. The resources potentially covered are: Vpc, InternetGateway, PrivateSubnet, and PublicSubnet. As with `key_helper`, these resources will be deleted if dcos-launch is used for destroying the deployment
* `disable_rollback` (for AWS clusters): (`true` or `false`) This is false by default if omitted. Disabling rollback will prevent your cluster from being garbage-collected, so make sure you delete it when you are done. See [here](../README.md) for instructions on how to delete the cluster if you have enabled rollback protection.

### Support
* `onprem` can only be provisioned via `aws` platform