Merge pull request #670 from willianpaixao/add-example-3

Adding a first complete example code

Author: armsnyder

examples/gitlab-managed-state/README.md

@@ -0,0 +1,62 @@
+# Terraform provider example
+
+## Getting started
+
+### Gitlab access token
+
+First create an access token, with the `api` scope and save that in a secure place (you won't be able to see it again). See the [documentation](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) for further information.
+The simplest way to provide the token is in a variable file:
+
+```shell
+$ ACCESS_TOKEN="YOUR_GITLAB_TOKEN"
+$ echo gitlab_token = "\"${ACCESS_TOKEN}\"" >> terraform.tfvars
+```
+
+### Kick-starting the backend
+
+Then you need to initialize the state file, by simply replacing the variables and running the following command:
+
+```shell
+$ USERNAME="YOUR_GITLAB_USERNAME"
+$ ACCESS_TOKEN="YOUR_GITLAB_TOKEN"
+$ PROJECT_ID="12345678"
+$ STATE_NAME="default"
+
+$ ADDRESS="https://gitlab.com/api/v4/projects/${PROJECT_ID}/terraform/state/${STATE_NAME}"
+
+$ terraform init \
+    -backend-config="address=${ADDRESS}" \
+    -backend-config="lock_address=${ADDRESS}/lock" \
+    -backend-config="unlock_address=${ADDRESS}/lock" \
+    -backend-config="username=${USERNAME}" \
+    -backend-config="password=${ACCESS_TOKEN}" \
+    -backend-config="lock_method=POST" \
+    -backend-config="unlock_method=DELETE" \
+    -backend-config="retry_wait_min=5"
+    -backend-config="password=${ACCESS_TOKEN}"
+```
+
+The available arguments and valid values can be seen in the [Terraform documentation](https://www.terraform.io/docs/language/settings/backends/http.html#configuration-variables).
+
+Check the newly created state by running `terraform plan`.
+
+## Creating the infrastructure
+
+Once the backend is initiated, you can start to create your resources:
+
+```shell
+$ terraform apply
+```
+
+## Destroying all resources
+
+Similarly, all resources can be deleted or scheduled for deletion by running:
+
+```shell
+$ terraform destroy
+```
+
+## References
+
+1. [GitLab managed Terraform State](https://docs.gitlab.com/ee/user/infrastructure/terraform_state.html)
+2. [Infrastructure as code with Terraform and GitLab](https://docs.gitlab.com/ee/user/infrastructure/index.html)

examples/gitlab-managed-state/main.tf

@@ -0,0 +1,99 @@
+terraform {
+  backend "http" {
+  }
+
+  required_providers {
+    gitlab = {
+      source  = "gitlabhq/gitlab"
+      version = "3.7.0"
+    }
+  }
+}
+
+provider "gitlab" {
+  token = var.gitlab_token
+}
+
+resource "gitlab_group" "group" {
+  name             = "My Group"
+  path             = "my-group"
+  description      = "Promoting Open Source Projects"
+  visibility_level = "public"
+
+  lifecycle {
+    prevent_destroy = true
+  }
+}
+
+resource "gitlab_group_membership" "group_membership" {
+  for_each = var.group_members
+
+  group_id     = gitlab_group.group.id
+  user_id      = each.key
+  access_level = each.value
+}
+
+resource "gitlab_project" "api" {
+  name         = "api"
+  description  = "An example project"
+  namespace_id = gitlab_group.group.id
+
+  only_allow_merge_if_all_discussions_are_resolved = true
+  only_allow_merge_if_pipeline_succeeds            = true
+  remove_source_branch_after_merge                 = true
+
+  container_registry_enabled = false
+  lfs_enabled                = false
+  packages_enabled           = false
+  request_access_enabled     = false
+  shared_runners_enabled     = false
+  snippets_enabled           = false
+  wiki_enabled               = false
+
+  tags = setunion(var.tags, ["api", "backend", "rest"])
+}
+
+resource "gitlab_branch_protection" "main" {
+  project            = gitlab_project.api.id
+  branch             = "main"
+  push_access_level  = "developer"
+  merge_access_level = "developer"
+}
+
+resource "gitlab_project_approval_rule" "default" {
+  project            = gitlab_project.api.id
+  name               = "Minimum one approval required"
+  approvals_required = 1
+}
+
+resource "gitlab_project_level_mr_approvals" "default" {
+  project_id                                 = gitlab_project.api.id
+  merge_requests_author_approval             = false
+  merge_requests_disable_committers_approval = true
+  reset_approvals_on_push                    = true
+}
+
+resource "gitlab_pipeline_trigger" "default" {
+  project     = gitlab_project.api.id
+  description = "Used to trigger builds in bulk"
+}
+
+resource "gitlab_deploy_token" "default" {
+  project = gitlab_project.api.id
+  name    = "Default deploy token"
+  scopes  = ["read_repository", "read_registry"]
+}
+
+resource "gitlab_label" "bug" {
+  project     = gitlab_project.api.id
+  name        = "bug"
+  description = "issue for flagging bugs and/or errors"
+  color       = "#ff0000"
+}
+
+resource "gitlab_label" "documentation" {
+  project     = gitlab_project.api.id
+  name        = "documentation"
+  description = "issue for documentation updates"
+  color       = "#00ff00"
+}

examples/gitlab-managed-state/outputs.tf

@@ -0,0 +1,14 @@
+output "id" {
+  value       = gitlab_project.api.id
+  description = "Integer that uniquely identifies the project within the gitlab install"
+}
+
+output "path_with_namespace" {
+  value       = gitlab_project.api.path_with_namespace
+  description = "The path of the repository with namespace"
+}
+
+output "web_url" {
+  value       = gitlab_project.api.web_url
+  description = "URL that can be used to find the project in a browser"
+}

examples/gitlab-managed-state/variables.tf

@@ -0,0 +1,23 @@
+variable "gitlab_token" {
+  type        = string
+  description = "GitLab personal access token"
+  sensitive   = true
+}
+
+variable "group_members" {
+  description = <<EOF
+All members of the group and its [access level](https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions).
+Possible values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`
+EOF
+  type        = map(string)
+  default = {
+    "1234567" = "owner"
+    "2345678" = "developer"
+  }
+}
+
+variable "tags" {
+  type        = list(string)
+  description = "A list of tags (topics) of the project"
+  default     = ["gitlab", "terraform"]
+}