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

64 lines
1.7 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: "GitLab: gitlab_project"
Adding all of the gitlab resources to the sidebar
2017-05-27 14:50:06 +02:00
sidebar_current: "docs-gitlab-resource-project-x"
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
description: |-
provider/gitlab: Improve gitlab documentation (#14827) * fix gitlab naming seems like some github stuff was not renamed * gitlab is using group or user instead of organisations * add namespace_id to gitlab_project documentation * it's not possible to manage group members
2017-05-31 20:00:45 +02:00
Creates and manages projects within GitLab groups or within your user
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
---
# gitlab\_project
This resource allows you to create and manage projects within your
provider/gitlab: Improve gitlab documentation (#14827) * fix gitlab naming seems like some github stuff was not renamed * gitlab is using group or user instead of organisations * add namespace_id to gitlab_project documentation * it's not possible to manage group members
2017-05-31 20:00:45 +02:00
GitLab group or within your user.
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
## 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: Documentation improvements (#14824) * provider/gitlab: Fix documentation copypasta The original provider and docs were copied from the github provider, one bit of copy paste slipped unmissed. * provider/gitlab: Document `gitlab_project#id` * provider/gitlab: Document `gitlab_project#namespace_id` * provider/gitlab: Add fuller demonstration to the provider page Following in the style of other provider pages, add a worked example showing off all of the available resources offered by the gitlab provider. * provider/gitlab: Correct sample for gitlab_project
2017-05-29 16:04:51 +02:00
resource "gitlab_project" "example" {
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
name = "example"
description = "My awesome codebase"
provider/gitlab: Documentation improvements (#14824) * provider/gitlab: Fix documentation copypasta The original provider and docs were copied from the github provider, one bit of copy paste slipped unmissed. * provider/gitlab: Document `gitlab_project#id` * provider/gitlab: Document `gitlab_project#namespace_id` * provider/gitlab: Add fuller demonstration to the provider page Following in the style of other provider pages, add a worked example showing off all of the available resources offered by the gitlab provider. * provider/gitlab: Correct sample for gitlab_project
2017-05-29 16:04:51 +02:00
visibility_level = "public"
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
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name of the project.
provider/gitlab: Improve gitlab documentation (#14827) * fix gitlab naming seems like some github stuff was not renamed * gitlab is using group or user instead of organisations * add namespace_id to gitlab_project documentation * it's not possible to manage group members
2017-05-31 20:00:45 +02:00
* `namespace_id` - (Optional) The namespace (group or user) of the project. Defaults to your user.
provider/gitlab: Documentation improvements (#14824) * provider/gitlab: Fix documentation copypasta The original provider and docs were copied from the github provider, one bit of copy paste slipped unmissed. * provider/gitlab: Document `gitlab_project#id` * provider/gitlab: Document `gitlab_project#namespace_id` * provider/gitlab: Add fuller demonstration to the provider page Following in the style of other provider pages, add a worked example showing off all of the available resources offered by the gitlab provider. * provider/gitlab: Correct sample for gitlab_project
2017-05-29 16:04:51 +02:00
See [`gitlab_group`](group.html) for an example.
provider/gitlab: Improve gitlab documentation (#14827) * fix gitlab naming seems like some github stuff was not renamed * gitlab is using group or user instead of organisations * add namespace_id to gitlab_project documentation * it's not possible to manage group members
2017-05-31 20:00:45 +02:00
* `description` - (Optional) A description of the project.
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
* `default_branch` - (Optional) The default branch for the project.
* `issues_enabled` - (Optional) Enable issue tracking for the project.
* `merge_requests_enabled` - (Optional) Enable merge requests for the project.
* `wiki_enabled` - (Optional) Enable wiki for the project.
* `snippets_enabled` - (Optional) Enable snippets for the project.
Fix gitlab documentation (#14803) * fix gitlab_project resource documentation * improve gitlab provider documentation
2017-05-25 08:51:42 +02:00
* `visibility_level` - (Optional) Set to `public` to create a public project.
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
Valid values are `private`, `internal`, `public`.
Repositories are created as private by default.
## Attributes Reference
The following additional attributes are exported:
provider/gitlab: Documentation improvements (#14824) * provider/gitlab: Fix documentation copypasta The original provider and docs were copied from the github provider, one bit of copy paste slipped unmissed. * provider/gitlab: Document `gitlab_project#id` * provider/gitlab: Document `gitlab_project#namespace_id` * provider/gitlab: Add fuller demonstration to the provider page Following in the style of other provider pages, add a worked example showing off all of the available resources offered by the gitlab provider. * provider/gitlab: Correct sample for gitlab_project
2017-05-29 16:04:51 +02:00
* `id` - Integer that uniquely identifies the project within the gitlab install.
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
* `ssh_url_to_repo` - URL that can be provided to `git clone` to clone the
repository via SSH.
* `http_url_to_repo` - URL that can be provided to `git clone` to clone the
repository via HTTP.
* `web_url` - URL that can be used to find the project in a browser.