Skip to content

Commit 15c7961

Browse files
committed
feat: updated README
1 parent 868d59b commit 15c7961

File tree

1 file changed

+26
-39
lines changed

1 file changed

+26
-39
lines changed

‎README.md

+26-39
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,19 @@
11
# terraform-google-artifact-registry
22

3-
## Description
4-
### Tagline
5-
This is an auto-generated module.
6-
7-
### Detailed
8-
This module was generated from [terraform-google-module-template](https://github.com/terraform-google-modules/terraform-google-module-template/), which by default generates a module that simply creates a GCS bucket. As the module develops, this README should be updated.
3+
The Terraform module handles the creation of repositories in Artifact Registry on Google Cloud.
94

105
The resources/services/activations/deletions that this module will create/trigger are:
116

12-
- Create a GCS bucket with the provided name
13-
14-
### PreDeploy
15-
To deploy this blueprint you must have an active billing account and billing permissions.
16-
17-
## Architecture
18-
![alt text for diagram](https://www.link-to-architecture-diagram.com)
19-
1. Architecture description step no. 1
20-
2. Architecture description step no. 2
21-
3. Architecture description step no. N
22-
23-
## Documentation
24-
- [Hosting a Static Website](https://cloud.google.com/storage/docs/hosting-static-website)
7+
- Different repositories in Artifact Registry
8+
- docker, apt, yum, go, pypi, npm, maven
9+
- Provide Artifact Registry Reader or Writer roles to the users and service accounts
2510

26-
## Deployment Duration
27-
Configuration: X mins
28-
Deployment: Y mins
11+
## Assumptions and prerequisites
12+
This module assumes that below mentioned prerequisites are in place before consuming the module.
2913

30-
## Cost
31-
[Blueprint cost details](https://cloud.google.com/products/calculator?id=02fb0c45-cc29-4567-8cc6-f72ac9024add)
14+
- To deploy this blueprint you must have an active billing account and billing permissions.
15+
- APIs are enabled
16+
- Permissions are available
3217

3318
## Usage
3419

@@ -39,8 +24,11 @@ module "artifact_registry" {
3924
source = "terraform-google-modules/artifact-registry/google"
4025
version = "~> 0.1"
4126
42-
project_id = "<PROJECT ID>"
43-
bucket_name = "gcs-test-bucket"
27+
# Required variables
28+
project_id = "<PROJECT ID>"
29+
location = "<LOCATION>"
30+
format = "<REPO_FORMAT>"
31+
repository_id = "<REPO_NAME>"
4432
}
4533
```
4634

@@ -89,34 +77,33 @@ These sections describe requirements for using this module.
8977

9078
The following dependencies must be available:
9179

92-
- [Terraform][terraform] v0.13
93-
- [Terraform Provider for GCP][terraform-provider-gcp] plugin v3.0
80+
- [Terraform][terraform] v0.13+
81+
- [Terraform Provider for GCP][terraform-provider-gcp] plugin v3.0+
9482

9583
### Service Account
9684

97-
A service account with the following roles must be used to provision
98-
the resources of this module:
85+
A service account with the following roles must be used to provision the resources of this module:
9986

100-
- Storage Admin: `roles/storage.admin`
87+
- Artifact Registry Admin: `roles/artifactregistry.admin`
88+
- Secret Manager Admin: `roles/secretmanager.admin`
89+
- Context Manager Admin: `roles/contextmanager.admin`
10190

102-
The [Project Factory module][project-factory-module] and the
103-
[IAM module][iam-module] may be used in combination to provision a
104-
service account with the necessary roles applied.
91+
The [Project Factory module][project-factory-module] and the [IAM module][iam-module] may be used in combination to provision a service account with the necessary roles applied.
10592

10693
### APIs
10794

10895
A project with the following APIs enabled must be used to host the
10996
resources of this module:
11097

111-
- Google Cloud Storage JSON API: `storage-api.googleapis.com`
98+
- Artifact Registry JSON API: `artifactregistry.googleapis.com`
99+
- Secret Manager JSON API: `secretmanager.googleapis.com`
100+
- Context Manager JSON API: `contextmanager.googleapis.com`
112101

113-
The [Project Factory module][project-factory-module] can be used to
114-
provision a project with the necessary APIs enabled.
102+
The [Project Factory module][project-factory-module] can be used to provision a project with the necessary APIs enabled.
115103

116104
## Contributing
117105

118-
Refer to the [contribution guidelines](./CONTRIBUTING.md) for
119-
information on contributing to this module.
106+
Refer to the [contribution guidelines](./CONTRIBUTING.md) for information on contributing to this module.
120107

121108
[iam-module]: https://registry.terraform.io/modules/terraform-google-modules/iam/google
122109
[project-factory-module]: https://registry.terraform.io/modules/terraform-google-modules/project-factory/google

0 commit comments

Comments
 (0)