Skip to content

Commit 308ae7f

Browse files
anarwalanarwal
committed
update readme to release project
1 parent fc64a00 commit 308ae7f

File tree

2 files changed

+58
-30
lines changed

2 files changed

+58
-30
lines changed

‎README.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,27 +36,46 @@ module "gitlab" {
3636
dns_name = var.dns_name
3737
domain_name = var.domain_name
3838
zone_id = var.zone_id
39-
private_key_extension = ".pem"
40-
public_key_extension = ".pub"
41-
public_key_path = "./secrets"
39+
ssh_key_name = var.ssh_key_name
4240
gitlab_application_ami = var.gitlab_ami
43-
gitlab_artifactory_s3_bucket_name = "gitlab-artifactory"
44-
gitlab_lfs_s3_bucket_name = "gitlab-lfs"
45-
gitlab_packages_s3_bucket_name = "gitlab-packages"
46-
gitlab_registry_s3_bucket_name = "gitlab-registry"
47-
contact_email = "abhimanyunarwal@northwesternmutual.com"
41+
gitlab_artifactory_s3_bucket_name = var.gitlab_artifactory_s3_bucket_name
42+
gitlab_lfs_s3_bucket_name = var.gitlab_lfs_s3_bucket_name
43+
gitlab_packages_s3_bucket_name = var.gitlab_packages_s3_bucket_name
44+
gitlab_registry_s3_bucket_name = var.gitlab_registry_s3_bucket_name
4845
}
4946
```
5047

5148
## INPUT VALUES
5249

53-
| Input | Description | Type | Default | Required |
54-
| ------------------| -------------------------------------------------------------------------------| --------|---------|----------|
55-
| namespace | Namespace, which could be your organization name or abbreviation" |`string` | "" | yes |
56-
| stage | Stage, e.g. 'prod', 'staging', 'dev' |`string` | "" | yes |
57-
| name | Solution name, e.g. 'app' or 'jenkins' |`string` | "" | yes |
58-
| attributes | Additional attributes |`list` | `<list>`| no |
59-
| delimiter | Delimiter to be used between namespace, environment, stage, name and attributes|`string` | "-" | no |
50+
| Input | Description | Type | Default | Required |
51+
| ----------------------------------| --------------------------------------------------------------------------------------------------------------------------| --------|--------------------|----------|
52+
| namespace | Namespace, which could be your organization name or abbreviation" |`string` | "" | yes |
53+
| stage | Stage, e.g. 'prod', 'staging', 'dev' |`string` | "" | yes |
54+
| name | Solution name, e.g. 'app' or 'jenkins' |`string` | "" | yes |
55+
| attributes | Additional attributes |`list` | `<list>` | no |
56+
| delimiter | Delimiter to be used between namespace, environment, stage, name and attributes |`string` | "-" | no |
57+
| force_destroy_s3_bucket | Boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. | `bool` | `false` | no |
58+
| gitlab_artifactory_s3_bucket_name | Name of Gitlab Artifactory S3 bucket | `string`| "" | yes |
59+
| gitlab_lfs_s3_bucket_name | Name of Gitlab LFS S3 bucket | `string`| "" | yes |
60+
| gitlab_packages_s3_bucket_name | Name of Gitlab Packages S3 bucket | `string`| "" | yes |
61+
| gitlab_registry_s3_bucket_name | Name of Gitlab Registry S3 bucket | `string`| "" | yes |
62+
| dns_name | Domain name for which the certificate should be issued | `string`| "" | yes |
63+
| domain_name | ALB record53 entry domain name | `string`| "" | yes |
64+
| public_subnet_id | List of public subnet IDs to attach | `list` | `<list>` | yes |
65+
| private_subnet_id | List of private subnet IDs to attach | `list` | `<list>` | yes |
66+
| vpc_id | Id of the VPC Gitlab will be provisioned in | `string`| "" | yes |
67+
| gitlab_data_disk_size | Size of gitlab data disk to provision | `number`| `100` | no |
68+
| gitlab_data_disk_device_name | Name of gitlab data disk | `string`| `/dev/xvdi` | no |
69+
| git_data_directory | Name of gitlab data disk | `string`| `/mnt/gitlab-data` | no |
70+
| snapshot_interval | How often this lifecycle policy should be evaluated | `string`| `24` | no |
71+
| snapshot_start_time | List of times in 24 hour clock format that sets when the lifecycle policy should be evaluated | `string`| `00:00` | no |
72+
| retain_rule | How many snapshots to keep. Must be an integer between 1 and 1000. | `number`| `10` | no |
73+
| gitlab_alb_ideal_timeout | Time in seconds that the connection is allowed to be idle. | `number`| `60` | no |
74+
| gitlab_application_ami | AMI of gitlab application to be used with Gitlab instance. | `string`| "" | yes |
75+
| zone_id | ID of the hosted zone to contain Route53 record. | `string`| "" | yes |
76+
| alias | Display name of KMS Key alias. Name must start with the word `alias` followed by a forward slash | `string`| `alias/gitlab-kms` | no |
77+
| enable_key_rotation | Specifies whether key rotation is enabled | `bool` | `true` | no |
78+
| ssh_key_name | SSH key for ec2 ssh | `string`| "" | yes |
6079

6180
## OUTPUT VALUE NAMES
6281

‎module/single-node-omnibus/variables.tf

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,19 @@ variable "gitlab_artifactory_s3_bucket_name" {
4141

4242
variable "gitlab_lfs_s3_bucket_name" {
4343
type = string
44-
description = "Name of Gitlab Artifactory S3 bucket"
44+
description = "Name of Gitlab LFS S3 bucket"
4545
default = ""
4646
}
4747

4848
variable "gitlab_packages_s3_bucket_name" {
4949
type = string
50-
description = "Name of Gitlab Artifactory S3 bucket"
50+
description = "Name of Gitlab Packages S3 bucket"
5151
default = ""
5252
}
5353

5454
variable "gitlab_registry_s3_bucket_name" {
5555
type = string
56-
description = "Name of Gitlab Artifactory S3 bucket"
56+
description = "Name of Gitlab Registry S3 bucket"
5757
default = ""
5858
}
5959

@@ -82,55 +82,64 @@ variable "private_subnet_id" {
8282
}
8383

8484
variable "vpc_id" {
85+
type = string
8586
description = "Id of the VPC Gitlab will be provisioned in."
8687
default = ""
8788
}
8889

8990
variable "gitlab_data_disk_size" {
90-
description = "The size of the wal disks to provision"
91-
default = 100
91+
description = "The size of gitlab data disk to provision"
92+
default = 100
9293
}
9394

9495
variable "gitlab_data_disk_device_name" {
95-
description = "The name of the meta device"
96-
default = "/dev/xvdi"
96+
type = string
97+
description = "The name gitlab data disk"
98+
default = "/dev/xvdi"
9799
}
98100

99101
variable "git_data_directory" {
102+
type = string
100103
default = "/mnt/gitlab-data"
101104
}
102105

103106
variable "snapshot_interval" {
107+
type = string
104108
description = "How often this lifecycle policy should be evaluated. 2,3,4,6,8,12 or 24 are valid values. Default 24"
105-
default = "24"
109+
default = "24"
106110
}
107111

108112
variable "snapshot_start_time" {
113+
type = string
109114
description = "A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated."
110-
default = "00:00"
115+
default = "00:00"
111116
}
112117

113118
variable "retain_rule" {
114119
description = "How many snapshots to keep. Must be an integer between 1 and 1000."
115-
default = "3"
120+
default = 10
116121
}
117122

118123
variable "gitlab_alb_ideal_timeout" {
119124
description = "The time in seconds that the connection is allowed to be idle."
120-
default = 60
125+
default = 60
121126
}
122127

123128
variable "rotation_status" {
124-
default = "1"
129+
type = string
130+
description = "Rotation status for S3 IAM user, 0 or 1"
131+
default = "1"
125132
}
126133

127134
variable "gitlab_application_ami" {
128-
description = "AMI of gitlab application to be used with Launch Configuration"
135+
type = string
136+
description = "AMI of gitlab application to be used with Gitlab instance. AMI can be build using Packer like: https://github.com/university-outreach-infrastructure-tf/gitlab-packer-ami"
129137
default = ""
130138
}
131139

132140
variable "zone_id" {
133-
description = "The ID of the hosted zone to contain this record."
141+
type = string
142+
description = "The ID of the hosted zone to contain Route53 record."
134143
default = ""
135144
}
136145

@@ -147,6 +156,6 @@ variable "enable_key_rotation" {
147156

148157
variable "ssh_key_name"{
149158
type = string
150-
description = "ssh key for ec2 ssh"
159+
description = "SSH key for ec2 ssh"
151160
default = ""
152161
}

0 commit comments

Comments
 (0)