Skip to content

Commit

Permalink
Merge pull request #322 from Rycieos/6.0upgrade-docs
Browse files Browse the repository at this point in the history
Add upgrade docs for 6.0
  • Loading branch information
morgante authored Nov 26, 2019
2 parents 5af035a + 97f3396 commit 9d0fa3c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Extending the adopted spec, each change should have a link to its corresponding

## [Unreleased]

## [6.0.0] - 2019-11-26

6.0.0 is a backwards incompatible release. See the [upgrade guide](./docs/upgrading_to_project_factory_v6.0.md) for details.

### Added

- Option to disable the default compute service account. [#313]
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ intended for Terraform 0.11.x is [2.4.1].

## Upgrading

The current version is 4.X. The following guides are available to assist with upgrades:
The current version is 6.X. The following guides are available to assist with upgrades:

- [0.X -> 1.0](./docs/upgrading_to_project_factory_v1.0.md)
- [1.X -> 2.0](./docs/upgrading_to_project_factory_v2.0.md)
- [3.X -> 4.0](./docs/upgrading_to_project_factory_v4.0.md)
- [4.X -> 5.0](./docs/upgrading_to_fabric_project_v5.0.md)
- [5.X -> 6.0](./docs/upgrading_to_project_factory_v6.0.md)

## Usage

Expand All @@ -32,7 +34,7 @@ There are multiple examples included in the [examples](./examples/) folder but s
```hcl
module "project-factory" {
source = "terraform-google-modules/project-factory/google"
version = "~> 4.0"
version = "~> 6.0"
name = "pf-test-1"
random_project_id = "true"
Expand Down
22 changes: 22 additions & 0 deletions docs/upgrading_to_project_factory_v6.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Upgrading to Project Factory v6.0

The v6.0 release of Project Factory is a backwards incompatible release for
new projects only, as it changes how the default compute service account is
treated when the project is created.

The default of `default_service_account` changed from `"delete"` to `"disable"`.
If you want to continue deleting the default compute service account for new
projects, you will need to specify:

```
default_service_account = "delete"
```

## Migration Instructions

Projects that are already created with the default not overridden don't need
any changes, as their service account is already deleted.

Note that changing `default_service_account` to `"disable"` from `"delete"` on
already created projects will not bring the service account back, as the input
is only applied on project creation.

0 comments on commit 9d0fa3c

Please sign in to comment.