Skip to content

Commit edfcec6

Browse files
Update docs/resources/space.md
Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update heroku/resource_heroku_space.go Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]> Update docs/resources/space.md Co-authored-by: Sandy Lai <[email protected]> Signed-off-by: Johnny Winn <[email protected]>
1 parent 76a0a04 commit edfcec6

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

docs/resources/space.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,35 @@ description: |-
1010

1111
Provides a Heroku Private Space resource for running apps in isolated, highly available, secure app execution environments.
1212

13-
Heroku Private Spaces support two generations:
13+
Both generations of the Heroku platform offer Private Spaces:
1414

15-
* **Cedar** (default): The original generation supporting all Private Space features including Shield spaces
16-
* **Fir**: The next-generation platform with enhanced capabilities for Cloud Native Buildpacks (CNB), but with some feature limitations
15+
* **Cedar** (default): The [Cedar generation](https://devcenter.heroku.com/articles/private-spaces#additional-features-for-cedar-private-spaces) supports all Private Space features, including Shield spaces.
16+
* ```
17+
* **Fir**: The next-generation platform supports enhanced capabilities for Cloud Native Buildpacks (CNB), but with has some [feature limitations](https://devcenter.heroku.com/articles/generations?preview=1#feature-parity) compared to Cedar Private Spaces.
1718
18-
~> **Note:** The `generation` parameter cannot be changed after space creation. Choose carefully based on your application requirements.
19+
~> **Note:** You can't change the `generation` parameter after space creation. Choose carefully based on your application requirements.
1920
2021
## Example Usage
2122
2223
A Heroku "team" was originally called an "organization", and that is still
2324
the identifier used in this resource.
2425
2526
```hcl-terraform
26-
// Create a new Cedar generation space (default)
27+
// Create a new Cedar-generation space (default)
2728
resource "heroku_space" "cedar_space" {
2829
name = "test-cedar-space"
2930
organization = "my-company"
3031
region = "virginia"
31-
shield = true // Cedar supports shield spaces
32+
shield = true // Cedar supports Shield spaces
3233
}
3334
34-
// Create a new Fir generation space
35+
// Create a new Fir-generation space
3536
resource "heroku_space" "fir_space" {
3637
name = "test-fir-space"
3738
organization = "my-company"
3839
region = "virginia"
3940
generation = "fir"
40-
// Note: Fir generation does not support shield spaces
41+
// Note: Shield spaces are unavailable for the Fir generation.
4142
}
4243
4344
// Create a new Heroku app in test-space, same region
@@ -57,13 +58,13 @@ The following arguments are supported:
5758

5859
* `name` - (Required) The name of the Private Space.
5960
* `organization` - (Required) The name of the Heroku Team which will own the Private Space.
60-
* `generation` - (Optional) The generation of the Private Space. Valid values are `cedar` and `fir`. Defaults to `cedar` for backward compatibility. Cannot be changed after creation.
61+
* `generation` - (Optional) The generation of the Heroku platform for the space. Valid values are `cedar` and `fir`. Defaults to `cedar` for backward compatibility. It can't be changed after space creation.
6162
* `cidr` - (Optional) The RFC-1918 CIDR the Private Space will use.
6263
It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
6364
* `data_cidr` - (Optional) The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection
6465
that's automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
65-
* `region` - (Optional) provision in a specific [Private Spaces region](https://devcenter.heroku.com/articles/regions#viewing-available-regions).
66-
* `shield` - (Optional) provision as a [Shield Private Space](https://devcenter.heroku.com/articles/private-spaces#shield-private-spaces). Note: Shield spaces are only supported for `cedar` generation.
66+
* `region` - (Optional) The [region](https://devcenter.heroku.com/articles/regions#viewing-available-regions) to provision a space in.
67+
* `shield` - (Optional) `true` if provisioning as a [Shield Private Space](https://devcenter.heroku.com/articles/private-spaces#shield-private-spaces). Note: Shield spaces are only supported for the `cedar` generation.
6768

6869
## Attributes Reference
6970

@@ -72,7 +73,7 @@ The following attributes are exported:
7273
* `id` - The ID (UUID) of the space.
7374
* `name` - The space's name.
7475
* `organization` - The space's Heroku Team.
75-
* `generation` - The space's generation (`cedar` or `fir`).
76+
* `generation` - The generation of the Heroku platform for the space (`cedar` or `fir`).
7677
* `region` - The space's region.
7778
* `cidr` - The space's CIDR.
7879
* `data_cidr` - The space's Data CIDR.

heroku/resource_heroku_space.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ func resourceHerokuSpaceRead(d *schema.ResourceData, meta interface{}) error {
171171
}
172172
generationStr := generation.(string)
173173
if space.Shield && !IsFeatureSupported(generationStr, "space", "shield") {
174-
tflog.Warn(context.TODO(), fmt.Sprintf("Space has shield enabled but shield is not supported for %s generation", generationStr))
174+
tflog.Warn(context.TODO(), fmt.Sprintf("Space has `shield` set to `true` but Shield spaces are unsupported for the %s generation", generationStr))
175175
}
176176

177177
log.Printf("[DEBUG] Set NAT source IPs to %s for %s", space.NAT.Sources, d.Id())

0 commit comments

Comments
 (0)