Skip to content

Commit

Permalink
Update plugin-k8s-custom-resource-status.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shlomodaari authored Jan 15, 2025
1 parent 6b0b12e commit 4c47437
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions content/en/plugins/plugin-k8s-custom-resource-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ In versions prior to 2.0.5, your configuration for custom resources would look l

```yaml
kind:
SealedSecret:
Foo:
stable:
conditions:
- status: "False"
Expand All @@ -54,7 +54,7 @@ kind:
In version 2.0.5 and 3.0.x, the configuration for custom resources has changed. You will need to update your configuration as shown below:

Check warning on line 54 in content/en/plugins/plugin-k8s-custom-resource-status.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/plugins/plugin-k8s-custom-resource-status.md#L54

[Google.Will] Avoid using ' will '.
Raw output
{"message": "[Google.Will] Avoid using ' will '.", "location": {"path": "content/en/plugins/plugin-k8s-custom-resource-status.md", "range": {"start": {"line": 54, "column": 84}}}, "severity": "WARNING"}
```yaml
kind:
- name: VPCEndpoint.ec2.aws.upbound.io
- name: Foo.example.com
status:
failed:
conditions:
Expand Down Expand Up @@ -321,7 +321,7 @@ spinnaker:

These properties are only for `Foo` kind. Every time you deploy `Foo`, the plugin compares the resource status values against these properties. In this case, the plugin marks the deployment as unavailable since it matches your custom resource.

#### Example 1.2: Config for all Custom Resources
#### Example 1.2: Global Config for all Custom Resources

Check warning on line 324 in content/en/plugins/plugin-k8s-custom-resource-status.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/plugins/plugin-k8s-custom-resource-status.md#L324

[Google.Headings] 'Example 1.2: Global Config for all Custom Resources' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Example 1.2: Global Config for all Custom Resources' should use sentence-style capitalization.", "location": {"path": "content/en/plugins/plugin-k8s-custom-resource-status.md", "range": {"start": {"line": 324, "column": 6}}}, "severity": "WARNING"}

```yaml
spinnaker:
Expand All @@ -330,9 +330,6 @@ spinnaker:
Armory.K8sCustomResourceStatus:
enabled: true
config:
kind:
- name: Foo.example.com
- name: Bar.example.com
status:
stable:
conditions:
Expand Down Expand Up @@ -362,7 +359,8 @@ spinnaker:
type: Reconciling
```

These properties apply to all custom resource kinds you deploy, `Foo` and `Bar` in this case. If you deploy different kinds with different statuses, you should declare per kind like in `Example 1.1`. In this case, the plugin marks the deployment as unavailable since that matches your custom resource.
These properties apply to all custom resource kinds you deploy through Spinnaker. If you deploy different kinds with different statuses, you should declare per kind like in `Example 2.1`. In this case, the plugin marks the deployment as ready since that
matches your custom resource.

### Example 2: Custom Resource with Non-Standard status fields

Expand Down

0 comments on commit 4c47437

Please sign in to comment.