Commit 6c56d270 authored by Amy Qualls's avatar Amy Qualls

Add Kubernetes explanatory information

Provide more information about the Kubernetes resources a user
might need. Experienced users will already know, but it may save
questions from newer users.
parent 900f072e
...@@ -40,9 +40,10 @@ using the Agent. ...@@ -40,9 +40,10 @@ using the Agent.
To use multiple YAML files, specify a `paths` attribute in the `gitops` section. To use multiple YAML files, specify a `paths` attribute in the `gitops` section.
By default, the Agent monitors all types of resources. You can exclude some types of resources By default, the Agent monitors all
from monitoring. This enables you to reduce the permissions needed by the GitOps feature, [Kubernetes object types](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields).
through `resource_exclusions`. You can exclude some types of resources from monitoring. This enables you to reduce
the permissions needed by the GitOps feature, through `resource_exclusions`.
To enable a specific named resource, first use `resource_inclusions` to enable desired resources. To enable a specific named resource, first use `resource_inclusions` to enable desired resources.
The following file excerpt includes specific `api_groups` and `kinds`. The `resource_exclusions` The following file excerpt includes specific `api_groups` and `kinds`. The `resource_exclusions`
...@@ -60,6 +61,8 @@ gitops: ...@@ -60,6 +61,8 @@ gitops:
# Holds the only API groups and kinds of resources that gitops will monitor. # Holds the only API groups and kinds of resources that gitops will monitor.
# Inclusion rules are evaluated first, then exclusion rules. # Inclusion rules are evaluated first, then exclusion rules.
# If there is still no match, resource is monitored. # If there is still no match, resource is monitored.
# Resources: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
# Groups: https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-groups-and-versioning
resource_inclusions: resource_inclusions:
- api_groups: - api_groups:
- apps - apps
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment