Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add project resource documentation #22

Merged
merged 1 commit into from
Aug 18, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions website/docs/r/resource_project.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: "boundary"
page_title: "Boundary: project_resource"
sidebar_current: "docs-boundary-project-resource"
description: |-
Project resource for the Boundary Terraform provider.
---

# boundary_project_resource
The project resource allows you to configure a Boundary project.

## Example Usage

```hcl
resource "boundary_project" "foo" {
name = "foo_project"
description = "My first project!"
}
```

Usage for project-specific resources:

```hcl
resource "boundary_project" "foo" {
name = "foo_project"
}

resource "boundary_user" "foo" {
description = "foo user"
}

resource "boundary_group" "example" {
name = "My group"
description = "My first group!"
member_ids = [boundary_user.foo.id]
scope_id = boundary_project.foo.id
}
```

## Argument Reference

The following arguments are optional:
* `description` - The project description.
* `name` - The project name. Defaults to the resource name.