Skip to content

Commit 64725d9

Browse files
committed
Update README
1 parent d148c88 commit 64725d9

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -200,23 +200,18 @@ The project has the following folders and files:
200200
- /: root folder
201201
- /examples: examples for using this module
202202
- /helpers: Helper scripts
203-
- /modules: Specific implementations of the module (see Submodules section of this file)
204203
- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
205204
- /test: Folders with files for testing the module (see Testing section on this file)
206205
- /main.tf: main file for this module, contains all the resources to create
207206
- /variables.tf: all the variables for the module
208207
- /output.tf: the outputs of the module
209208
- /readme.MD: this file
210209

211-
## Submodules
210+
## Templating
212211

213-
To more cleanly handle cases where desired functionality would require complex duplication of Terraform resources (i.e. [PR 51](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/51)), this repository is divided into multiple submodules. To ensure backwards compatibility with the module before this change, the root module of the repository defers to the [`public-cluster`](./modules/public-cluster) submodule.
212+
To more cleanly handle cases where desired functionality would require complex duplication of Terraform resources (i.e. [PR 51](https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/51)), this repository is largely generated from the [`autogen`](./autogen) directory.
214213

215-
The following submodules currently exist:
216-
217-
- [`public-cluster`](./modules/public-cluster), which creates a GKE cluster with its nodes and endpoint publicly accessible.
218-
219-
Submodules and the root module are generated by running `make generate`. Changes to this repository should be made in the [`autogen`](./autogen) directory if they are intended to propagate to all submodules.
214+
The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](./autogen) directory where appropriate.
220215

221216
## Testing
222217

0 commit comments

Comments
 (0)