Skip to content

Commit

Permalink
part 5
Browse files Browse the repository at this point in the history
  • Loading branch information
@nb-goog
nb-goog committed Oct 28, 2024
1 parent a24f87b commit 63e1362
Show file tree
Hide file tree
Showing 3 changed files with 320 additions and 4 deletions.
4 changes: 0 additions & 4 deletions config/servicemappings/cloudbuild.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,3 @@ spec:
- name: google_cloudbuild_workerpool
kind: CloudBuildWorkerPool
direct: true

- name: google_cloudkms_autokeyconfig
kind: KMSAutokeyConfig
direct: true
3 changes: 3 additions & 0 deletions config/servicemappings/kms.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,6 @@ spec:
containers:
- type: project
tfField: project
- name: google_kms_autokey_config
kind: KMSAutokeyConfig
direct: true
317 changes: 317 additions & 0 deletions ...google3-docs/resource-reference/generated/resource-docs/kms/kmsautokeyconfig.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,317 @@
{# AUTOGENERATED. DO NOT EDIT. #}

{% extends "config-connector/_base.html" %}

{% block page_title %}KMSAutokeyConfig{% endblock %}
{% block body %}


<table>
<thead>
<tr>
<th><strong>Property</strong></th>
<th><strong>Value</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>{{gcp_name_short}} Service Name</td>
<td>Cloud Key Management Service</td>
</tr>
<tr>
<td>{{gcp_name_short}} Service Documentation</td>
<td><a href="/kms/docs/">/kms/docs/</a></td>
</tr>
<tr>
<td>{{gcp_name_short}} REST Resource Name</td>
<td>v1.folders</td>
</tr>
<tr>
<td>{{gcp_name_short}} REST Resource Documentation</td>
<td><a href="/kms/docs/reference/rest/v1/folders">/kms/docs/reference/rest/v1/folders</a></td>
</tr>
<tr>
<td>{{product_name_short}} Resource Short Names</td>
<td>gcpkmsautokeyconfig<br>gcpkmsautokeyconfigs<br>kmsautokeyconfig</td>
</tr>
<tr>
<td>{{product_name_short}} Service Name</td>
<td>cloudkms.googleapis.com</td>
</tr>
<tr>
<td>{{product_name_short}} Resource Fully Qualified Name</td>
<td>kmsautokeyconfigs.kms.cnrm.cloud.google.com</td>
</tr>

<tr>
<td>Can Be Referenced by IAMPolicy/IAMPolicyMember</td>
<td>No</td>
</tr>


<tr>
<td>{{product_name_short}} Default Average Reconcile Interval In Seconds</td>
<td>600</td>
</tr>
</tbody>
</table>

## Custom Resource Definition Properties



### Spec
#### Schema
```yaml
folderRef:
external: string
name: string
namespace: string
keyProject:
external: string
kind: string
name: string
namespace: string
```
<table class="properties responsive">
<thead>
<tr>
<th colspan="2">Fields</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>folderRef</code></p>
<p><i>Required*</i></p>
</td>
<td>
<p><code class="apitype">object</code></p>
<p>{% verbatim %}Immutable. The folder that this resource belongs to.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>folderRef.external</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The 'name' field of a folder, when not managed by Config Connector. This field must be set when 'name' field is not set.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>folderRef.name</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The 'name' field of a 'Folder' resource. This field must be set when 'external' field is not set.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>folderRef.namespace</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The 'namespace' field of a 'Folder' resource. If unset, the namespace is defaulted to the namespace of the referencer resource.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>keyProject</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">object</code></p>
<p>{% verbatim %}The Project that this resource belongs to.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>keyProject.external</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The `projectID` field of a project, when not managed by Config Connector.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>keyProject.kind</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The kind of the Project resource; optional but must be `Project` if provided.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>keyProject.name</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The `name` field of a `Project` resource.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td>
<p><code>keyProject.namespace</code></p>
<p><i>Optional</i></p>
</td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}The `namespace` field of a `Project` resource.{% endverbatim %}</p>
</td>
</tr>
</tbody>
</table>


<p>* Field is required when parent field is specified</p>


### Status
#### Schema
```yaml
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
externalRef: string
observedGeneration: integer
observedState:
state: string
```

<table class="properties responsive">
<thead>
<tr>
<th colspan="2">Fields</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>conditions</code></td>
<td>
<p><code class="apitype">list (object)</code></p>
<p>{% verbatim %}Conditions represent the latest available observations of the object's current state.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>conditions[]</code></td>
<td>
<p><code class="apitype">object</code></p>
<p>{% verbatim %}{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>conditions[].lastTransitionTime</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}Last time the condition transitioned from one status to another.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>conditions[].message</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}Human-readable message indicating details about last transition.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>conditions[].reason</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}Unique, one-word, CamelCase reason for the condition's last transition.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>conditions[].status</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}Status is the status of the condition. Can be True, False, Unknown.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>conditions[].type</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}Type is the type of the condition.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>externalRef</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}A unique specifier for the KMSAutokeyConfig resource in GCP.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>observedGeneration</code></td>
<td>
<p><code class="apitype">integer</code></p>
<p>{% verbatim %}ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>observedState</code></td>
<td>
<p><code class="apitype">object</code></p>
<p>{% verbatim %}ObservedState is the state of the resource as most recently observed in GCP.{% endverbatim %}</p>
</td>
</tr>
<tr>
<td><code>observedState.state</code></td>
<td>
<p><code class="apitype">string</code></p>
<p>{% verbatim %}Output only. Current state of this AutokeyConfig.{% endverbatim %}</p>
</td>
</tr>
</tbody>
</table>

## Sample YAML(s)

### Typical Use Case
```yaml
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: kms.cnrm.cloud.google.com/v1beta1
kind: KMSAutokeyConfig
metadata:
name: kmsautokeyconfig-sample
spec:
folderRef:
# Replace "${FOLDER_ID?}" with the numeric ID for your folder
external: folders/342684370552
keyProject:
# Replace ${PROJECT_ID?} with your project ID
external: projects/kmsproject-abcd
```


Note: If you have any trouble with instantiating the resource, refer to <a href="/config-connector/docs/troubleshooting">Troubleshoot Config Connector</a>.

{% endblock %}

0 comments on commit 63e1362

Please sign in to comment.