Skip to content

Commit

Permalink
move misplaced changelog entries (#67)
Browse files Browse the repository at this point in the history
* move entries to correct place in changelog
* update changelog and readme migration
  • Loading branch information
Phil Varner authored May 24, 2024
1 parent 88b5c4d commit bf0b3b8
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 24 deletions.
19 changes: 10 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

- For both `stac_server_inputs` and `titiler_inputs`, renamed
`stac_server_and_titiler_s3_arns` to `authorized_s3_arns`.
- `private_subnets_az_to_id_map` now correctly using ID as the map value instead of previous cidr_block
- `public_subnets_az_to_id_map` now correctly using ID as the map value instead of previous cidr_block

### Removed

- VPC and subnets are no longer created by the FD VPC module, since IDs must now be provided
for preexisting resources. If `deploy_vpc` was set to `true` on a previous terrform apply,
then this update will to attempt to delete the VPC and subnets, which will fail due to
resource dependencies. The TF state will need to be manually updated to remove these
references without deleting the underlying AWS resources.

## [2.25.0] - 2024-05-21

Expand Down Expand Up @@ -59,15 +69,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Access-Control-Allow-Methods: `CORS_METHODS`
- Access-Control-Allow-Headers: `CORS_HEADERS`

### Changed

- private_subnets_az_to_id_map now correctly using ID as the map value instead of previous cidr_block
- public_subnets_az_to_id_map now correctly using ID as the map value instead of previous cidr_block

### Removed

- VPC and subnets are no longer created by the FD VPC module, since IDs must now be provided for preexisting resources. If `deploy_vpc` was set to `true` on a previous terrform apply, then this update will to attempt to delete the VPC and subnets, which will fail due to resource dependencies. The TF state will need to be manually updated to remove these references without deleting the underlying AWS resources.

## [2.21.0] - 2024-05-10

### Changed
Expand Down
46 changes: 31 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ and has been re-created for this repository.

## Dependencies and Setup

* Bash &nbsp;<sub><sup>(versions tested: 5, 3.2)<sub><sup>
* terraform
* nvm
* tfenv
- Bash &nbsp;<sub><sup>(versions tested: 5, 3.2)<sub><sup>
- terraform
- nvm
- tfenv

On Mac, install the two version management dependencies with:

```shell
brew install tfenv nvm
```

*Note: if you already have `terraform` installed, you may need to unlink it
-Note: if you already have `terraform` installed, you may need to unlink it
first (`brew unlink terraform`), as the homebrew packages for `tfenv` and
`terraform` are mutually exclusive.*

Expand Down Expand Up @@ -303,18 +303,34 @@ re-try your destroy.
Document any changes that need to be made by module instances using these modules to uptake
a newer version. For example, if a new required variable is added, this should be documented here.

### Unreleased

- Removes support for VPC creation. To retain the existing VPC resources, manually
remove them from the Terraform state file. However, you should then create another
IaC deployment for that VPC.
- `stac_server_inputs` and `titiler_inputs`, renamed
`stac_server_and_titiler_s3_arns` to `authorized_s3_arns`.
- `titiler_inputs.mosaic_titiler_release_tag` is now `titiler_inputs.version`
- `cirrus_dashboard_inputs.cirrus_dashboard_release` is now `cirrus_dashboard_inputs.version`
- `console_ui_inputs.filmdrop_ui_release` is now `console_ui_inputs.version`
- `deploy_sample_data_bucket` option has been removed

### 2.x

- There were certainly many, but they were not documented.

### 1.7.0

* Remove cirrus_dashboard_release_tag uses in deployment to use new default version of v0.5.1
* Please upgrade to AWS provider `~=5.20`
- Remove cirrus_dashboard_release_tag uses in deployment to use new default version of v0.5.1
- Please upgrade to AWS provider `~=5.20`

### 1.6.0

* The jupyterhub-dask-eks module no longer takes a parameter `kubernetes_cluster_name`,
- The jupyterhub-dask-eks module no longer takes a parameter `kubernetes_cluster_name`,
but now requires a parameter `environment`. Resource names that previously used
`kubernetes_cluster_name` now construct those using the `project_name` and `environment`
variables
* The default OpenSearch cluster name has changed to include both
- The default OpenSearch cluster name has changed to include both
environment/stage, to allow for multiple deployments to a single AWS account.
Unfortunately, an OpenSearch cluster name can't be changed after creation, so
running a TF apply would attempt to destroy the old cluster and create a new
Expand All @@ -326,30 +342,30 @@ a newer version. For example, if a new required variable is added, this should b

### 1.5.0

* console-ui.filmdrop_ui_release must be gte 4.x, e.g., `v4.0.1`. Along with this,
- console-ui.filmdrop_ui_release must be gte 4.x, e.g., `v4.0.1`. Along with this,
the `filmdrop_ui_env` variable should be removed, the .env files deleted, and the
`VITE_APP_NAME` variable moved to `APP_NAME` in the config json file.

### 1.4.x

* Please upgrade to AWS provider `~=5.13`
* The WAF rules for mosaic titiler have been defined in the mosaic-titler module. The consumer
- Please upgrade to AWS provider `~=5.13`
- The WAF rules for mosaic titiler have been defined in the mosaic-titler module. The consumer
must now pass in an "aws.east" provider because cloudfront requires global resources created in
us-east-1. Consumers should set the new "waf_allowed_url" variable to set the WAF rules to enable
blocking of requests. Leaving the default of null will set the rules to count only and disable
blocking. If the consumer has previous defined a mosaic titiler WAF rule using the "titiler_waf_rules_map"
variable, this should be removed as it has been replaced with the module's implementation.
* Remove the OpenSearch service linked role from the terraform state with `terraform state rm 'aws_iam_service_linked_role.opensearch_linked_role'`
- Remove the OpenSearch service linked role from the terraform state with `terraform state rm 'aws_iam_service_linked_role.opensearch_linked_role'`

### 1.3.0

* If your deployment does not use cloudfront in front of stac-server, the stac_api_rootpath variable
- If your deployment does not use cloudfront in front of stac-server, the stac_api_rootpath variable
in stac-server/inputs.tf must be set to null. The default (empty string) is correct for when
cloudfront is in use.

### 1.2.0

* FilmDrop UI version >= 3.0.0 is now required. Previously, the configuration file was a
- FilmDrop UI version >= 3.0.0 is now required. Previously, the configuration file was a
JavaScript file and was placed in `./src/assets/config.js`. It is now a JSON file and is
placed in `./public/config/config.json`. This change can be seen in
[this commit](https://github.com/Element84/filmdrop-ui/pull/202/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed).
Expand Down

0 comments on commit bf0b3b8

Please sign in to comment.