-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: generate docs for teams and users
- Loading branch information
Showing
3 changed files
with
94 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ctfd_teams Data Source - terraform-provider-ctfd" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# ctfd_teams (Data Source) | ||
|
||
|
||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Read-Only | ||
|
||
- `affiliation` (String) Affiliation to a company or agency. | ||
- `banned` (Boolean) Is true if the team is banned from the CTF. | ||
- `captain` (String) Member who is captain of the team. Must be part of the members too. | ||
- `country` (String) Country the team represent or is hail from. | ||
- `email` (String) Email of the team. | ||
- `hidden` (Boolean) Is true if the team is hidden to the participants. | ||
- `id` (String) Identifier of the user. | ||
- `members` (List of String) List of members (User), defined by their IDs. | ||
- `name` (String) Name of the team. | ||
- `password` (String) Password of the team. Notice that during a CTF you may not want to update those to avoid defaulting team accesses. | ||
- `website` (String) Website, blog, or anything similar (displayed to other participants). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ctfd_team Resource - terraform-provider-ctfd" | ||
subcategory: "" | ||
description: |- | ||
CTFd defines a Team as a group of Users who will attend the Capture The Flag event. | ||
--- | ||
|
||
# ctfd_team (Resource) | ||
|
||
CTFd defines a Team as a group of Users who will attend the Capture The Flag event. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ctfd_user" "ctfer" { | ||
name = "CTFer" | ||
email = "[email protected]" | ||
password = "password" | ||
} | ||
resource "ctfd_team" "cybercombattants" { | ||
name = "Les cybercombattants de l'innovation" | ||
email = "[email protected]" | ||
password = "password" | ||
members = [ | ||
ctfd_user.ctfer.id, | ||
] | ||
captain = ctfd_user.ctfer.id | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `captain` (String) Member who is captain of the team. Must be part of the members too. | ||
- `email` (String) Email of the team. | ||
- `members` (List of String) List of members (User), defined by their IDs. | ||
- `name` (String) Name of the team. | ||
- `password` (String) Password of the team. Notice that during a CTF you may not want to update those to avoid defaulting team accesses. | ||
|
||
### Optional | ||
|
||
- `affiliation` (String) Affiliation to a company or agency. | ||
- `banned` (Boolean) Is true if the team is banned from the CTF. | ||
- `country` (String) Country the team represent or is hail from. | ||
- `hidden` (Boolean) Is true if the team is hidden to the participants. | ||
- `website` (String) Website, blog, or anything similar (displayed to other participants). | ||
|
||
### Read-Only | ||
|
||
- `id` (String) Identifier of the user. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
# User can be imported by the CTFd ID (check URLs) | ||
terraform import ctfd_team.cybercombattants 1 | ||
``` |