forked from hashicorp/hcp-terraform-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
app.terraform.io_projects.yaml
278 lines (278 loc) · 12.3 KB
/
app.terraform.io_projects.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.14.0
name: projects.app.terraform.io
spec:
group: app.terraform.io
names:
kind: Project
listKind: ProjectList
plural: projects
singular: project
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.name
name: Project Name
type: string
- jsonPath: .status.id
name: Project ID
type: string
name: v1alpha2
schema:
openAPIV3Schema:
description: Project is the Schema for the projects API
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: |-
ProjectSpec defines the desired state of Project.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/workspaces/organize-workspaces-with-projects
properties:
name:
description: Name of the Project.
minLength: 1
type: string
organization:
description: |-
Organization name where the Workspace will be created.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/organizations
minLength: 1
type: string
teamAccess:
description: |-
HCP Terraform's access model is team-based. In order to perform an action within a HCP Terraform organization,
users must belong to a team that has been granted the appropriate permissions.
You can assign project-specific permissions to teams.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/workspaces/organize-workspaces-with-projects#permissions
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/permissions#project-permissions
items:
description: |-
HCP Terraform's access model is team-based. In order to perform an action within a HCP Terraform organization,
users must belong to a team that has been granted the appropriate permissions.
You can assign project-specific permissions to teams.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/workspaces/organize-workspaces-with-projects#permissions
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/permissions#project-permissions
properties:
access:
description: |-
There are two ways to choose which permissions a given team has on a project: fixed permission sets, and custom permissions.
Must be one of the following values: `admin`, `custom`, `maintain`, `read`, `write`.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/permissions#project-permissions
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/permissions#general-project-permissions
enum:
- admin
- custom
- maintain
- read
- write
type: string
custom:
description: |-
Custom permissions let you assign specific, finer-grained permissions to a team than the broader fixed permission sets provide.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/permissions#custom-project-permissions
properties:
createWorkspace:
default: false
description: |-
Allow users to create workspaces in the project.
This grants read access to all workspaces in the project.
Default: `false`.
type: boolean
deleteWorkspace:
default: false
description: |-
Allows users to delete workspaces in the project.
Default: `false`.
type: boolean
lockWorkspace:
default: false
description: |-
Allows users to manually lock the workspace to temporarily prevent runs.
When a workspace's execution mode is set to "local", users must have this permission to perform local CLI runs using the workspace's state.
Default: `false`.
type: boolean
moveWorkspace:
default: false
description: |-
Allows users to move workspaces out of the project.
A user must have this permission on both the source and destination project to successfully move a workspace from one project to another.
Default: `false`.
type: boolean
projectAccess:
default: read
description: |-
Project access.
Must be one of the following values: `delete`, `read`, `update`.
Default: `read`.
enum:
- delete
- read
- update
type: string
runTasks:
description: |-
Manage Workspace Run Tasks.
Default: `false`.
type: boolean
runs:
default: read
description: |-
Run access.
Must be one of the following values: `apply`, `plan`, `read`.
Default: `read`.
enum:
- apply
- plan
- read
type: string
sentinelMocks:
default: none
description: |-
Download Sentinel mocks.
Must be one of the following values: `none`, `read`.
Default: `none`.
enum:
- none
- read
type: string
stateVersions:
default: none
description: |-
State access.
Must be one of the following values: `none`, `read`, `read-outputs`, `write`.
Default: `none`.
enum:
- none
- read
- read-outputs
- write
type: string
teamManagement:
default: none
description: |-
Team management.
Must be one of the following values: `manage`, `none`, `read`.
Default: `none`.
enum:
- manage
- none
- read
type: string
variables:
default: none
description: |-
Variable access.
Must be one of the following values: `none`, `read`, `write`.
Default: `none`.
enum:
- none
- read
- write
type: string
type: object
team:
description: |-
Team to grant access.
More information:
- https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/teams
properties:
id:
description: |-
Team ID.
Must match pattern: `^team-[a-zA-Z0-9]+$`
pattern: ^team-[a-zA-Z0-9]+$
type: string
name:
description: Team name.
minLength: 1
type: string
type: object
required:
- access
- team
type: object
minItems: 1
type: array
token:
description: API Token to be used for API calls.
properties:
secretKeyRef:
description: Selects a key of a secret in the workspace's namespace
properties:
key:
description: The key of the secret to select from. Must be
a valid secret key.
type: string
name:
description: |-
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
type: string
optional:
description: Specify whether the Secret or its key must be
defined
type: boolean
required:
- key
type: object
x-kubernetes-map-type: atomic
required:
- secretKeyRef
type: object
required:
- name
- organization
- token
type: object
status:
description: ProjectStatus defines the observed state of Project.
properties:
id:
description: Project ID.
type: string
name:
description: Project name.
type: string
observedGeneration:
description: Real world state generation.
format: int64
type: integer
required:
- id
- name
- observedGeneration
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}