README.md in convox_installer-3.0.0 vs README.md in convox_installer-3.0.1

- old
+ new

@@ -6,11 +6,10 @@ ## Requirements - MacOS - Convox v3 CLI -- Runtime integration installed in your AWS account. See: https://docs.convox.com/getting-started/introduction/ _Please let us know if you need to run this script on Linux. Linux support should not be too difficult to implement, but unfortunately we probably won't be able to support Windows._ ### Requires Convox >= 3 @@ -25,14 +24,16 @@ ## Features - Idempotent. If this script crashes, you can restart it and it will pick up where it left off. Every step looks up the existing state, and only makes a change if things are not yet set up (or out of sync). -- Ensures that the `convox` and `aws` CLI tools are installed +- Ensures that the `convox` and `terraform` CLI tools are installed - Wraps the `convox` CLI and parses JSON output from API calls -- Add n Docker Repository (e.g. ECR registry) +- Add a Docker Repository (e.g. ECR registry) - Set up an S3 bucket with an optional CORS policy +- Set up an RDS database (Postgres) +- Set up an Elasticache cluster (Redis) ## Introduction [Convox](https://convox.com/) is an awesome open source PaaS, which is like Heroku for your own AWS account. [`convox/rack`](https://github.com/convox/rack) is completely open source and free to use, but you can also sign up for a free or paid account to use the hosted service on convox.com. @@ -145,11 +146,11 @@ ## `ConvoxInstaller` DSL #### `ensure_requirements!` -Makes sure that the `convox` and `aws` CLI tools are installed on this system. If not, shows installation instructions and exits. +Makes sure that the `convox` and `terraform` CLI tools are installed on this system. If not, shows installation instructions and exits. #### `prompt_for_config` Loads config from ENV vars, or from saved config at `./.installer_config.json`. If any config settings are missing, it prompts the user for input. Finally, it shows a summary of the config, and asks the user if they want to proceed with the installation. If the user enters `y` (or `yes`), the `prompt_for_config` method completes. If they enter `n` (or `no`), we loop over every setting and let them press "enter" to keep the current value, or provide a new value to correct any mistakes. @@ -254,22 +255,19 @@ - `database_engine` _(default: 'postgres')_ - `database_engine_version` _(default: '14.2')_ - `database_instance_class` _(default: 'db.t3.medium')_ - `database_multi_az` _(default: true)_ -#### `add_add_elasticache_cluster` +#### `add_elasticache_cluster` Adds an Elasticache cluster to your Terraform config. - **Optional Config:** - `engine` _(default: 'redis')_ - - `engine_version` _(default: '6.2.5')_ - - `node_type` _(default: 'cache.m3.medium')_ - - `database_instance_class` _(default: 'db.t3.medium')_ + - `engine_version` _(default: '6.x')_ + - `node_type` _(default: 'cache.t3.medium')_ - `num_cache_nodes` _(default: 1)_ - `port` _(default: 6379)_ - -_IMPORTANT: Make sure you specify a full version string (e.g. `6.2.5`), and not a partial version (e.g. `6.2`.) A partial version will cause Terraform to delete and recreate the cluster on every run._ #### `apply_terraform_update!` Runs `terraform apply -auto-approve` to apply any changes to your Terraform configuration (add new resources, etc.)