Skip to content

Commit 38ff44b

Browse files
authored
docs: add errata summary between repo and published guide. (#219)
1 parent 4cc7ace commit 38ff44b

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

ERRATA.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Errata Summary
2+
This is an overview of the delta between the example foundation repository and the [Google Cloud security foundations guide](https://services.google.com/fh/files/misc/google-cloud-security-foundations-guide.pdf), including code discrepancies and notes on future automation. This document will be updated as new code is merged.
3+
4+
### Code Discrepancies
5+
6+
##### Labeling
7+
- The guide defines vpc-type for shared, service, float, nic, and peer projects. It does not define a vpc-type for Jenkins agents (vpc-b-jenkinsagents), the DNS Hub (vpc-dns-hub) and projects created in 4-projects.
8+
This will be addressed in the next version of the whitepaper.
9+
10+
##### Naming
11+
- The Service Account & Storage bucket naming are not aligned to the blueprint guide. Naming will be modified accordingly in a future release.
12+
13+
##### Pre-deployment Check
14+
- Terraform Validator, described in Section 5.2, is not implemented in the Cloud Build and Jenkins pipelines, but will be integrated in a future release.
15+
16+
### Notes
17+
- The BigQuery Log Detection solution, described in Section 10 will be integrated in a future release.
18+
- Splunk log integration will be integrated in a future release.
19+
- Cloud Asset Inventory will be integrated in a future release.
20+
- The unallocated IP address space in the Shared VPC networks, described in Section 7.3, is currently being used by Private Service Networking in this release.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,10 @@ Development happens on feature/bugfix branches (which can be named `feature/new-
243243

244244
Once validated in `development`, changes can be promoted to `non-production` by opening a PR/MR targeting the `non-production` branch and merging them. Similarly changes can be promoted from `non-production` to `production`.
245245

246+
## Errata Summary
247+
248+
Refer to the [Errata Summary](./ERRATA.md) for an overview of the delta between the example foundation repository and the [Google Cloud security foundations guide](https://services.google.com/fh/files/misc/google-cloud-security-foundations-guide.pdf).
249+
246250
## Contributing
247251

248252
Refer to the [contribution guidelines](./CONTRIBUTING.md) for

0 commit comments

Comments
 (0)