ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/source/docs/providers/gitlab/index.html.markdown

43 lines
1.3 KiB
Markdown
Raw Normal View History

provider/gitlab: add gitlab provider and `gitlab_project` resource Here we add a basic provider with a single resource type. It's copied heavily from the `github` provider and `github_repository` resource, as there is some overlap in those types/apis. ~~~ resource "gitlab_project" "test1" { name = "test1" visibility_level = "public" } ~~~ We implement in terms of the [go-gitlab](https://github.com/xanzy/go-gitlab) library, which provides a wrapping of the [gitlab api](https://docs.gitlab.com/ee/api/) We have been a little selective in the properties we surface for the project resource, as not all properties are very instructive. Notable is the removal of the `public` bool as the `visibility_level` will take precedent if both are supplied which leads to confusing interactions if they disagree.
2016-10-19 16:25:12 +02:00
---
layout: "gitlab"
page_title: "Provider: GitLab"
sidebar_current: "docs-gitlab-index"
description: |-
The GitLab provider is used to interact with GitLab organization resources.
---
# GitLab Provider
The GitLab provider is used to interact with GitLab organization resources.
The provider allows you to manage your GitLab organization's members and teams easily.
It needs to be configured with the proper credentials before it can be used.
Use the navigation to the left to read about the available resources.
## Example Usage
provider/gitlab: Addition of the documentation link for gitlab to sidebar ``` % make testacc TEST=./builtin/providers/gitlab ==> Checking that code complies with gofmt requirements... go generate $(go list ./... | grep -v /terraform/vendor/) 2017/04/27 05:37:02 Generated command/internal_plugin_list.go TF_ACC=1 go test ./builtin/providers/gitlab -v -timeout 120m === RUN TestProvider --- PASS: TestProvider (0.00s) === RUN TestProvider_impl --- PASS: TestProvider_impl (0.00s) === RUN TestAccGitlabProject_basic --- PASS: TestAccGitlabProject_basic (41.11s) === RUN TestGitlab_validation --- PASS: TestGitlab_validation (0.00s) === RUN TestGitlab_visbilityHelpers --- PASS: TestGitlab_visbilityHelpers (0.00s) PASS ok github.com/hashicorp/terraform/builtin/providers/gitlab 41.125s ```
2017-04-26 19:44:05 +02:00
```hcl
provider/gitlab: add gitlab provider and `gitlab_project` resource Here we add a basic provider with a single resource type. It's copied heavily from the `github` provider and `github_repository` resource, as there is some overlap in those types/apis. ~~~ resource "gitlab_project" "test1" { name = "test1" visibility_level = "public" } ~~~ We implement in terms of the [go-gitlab](https://github.com/xanzy/go-gitlab) library, which provides a wrapping of the [gitlab api](https://docs.gitlab.com/ee/api/) We have been a little selective in the properties we surface for the project resource, as not all properties are very instructive. Notable is the removal of the `public` bool as the `visibility_level` will take precedent if both are supplied which leads to confusing interactions if they disagree.
2016-10-19 16:25:12 +02:00
# Configure the GitLab Provider
provider "gitlab" {
token = "${var.github_token}"
}
# Add a project to the organization
resource "gitlab_project" "sample_project" {
...
}
```
## Argument Reference
The following arguments are supported in the `provider` block:
* `token` - (Optional) This is the GitLab personal access token. It must be provided, but
it can also be sourced from the `GITLAB_TOKEN` environment variable.
* `base_url` - (Optional) This is the target GitLab base API endpoint. Providing a value is a
Fix gitlab documentation (#14803) * fix gitlab_project resource documentation * improve gitlab provider documentation
2017-05-25 08:51:42 +02:00
requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v3/.
It is optional to provide this value and it can also be sourced from the `GITLAB_BASE_URL` environment variable.
The value must end with a slash.