Skip to content

Commit

Permalink
No need to escape these characters
Browse files Browse the repository at this point in the history
Signed-off-by: Pete Wall <[email protected]>
  • Loading branch information
petewall committed Oct 23, 2024
1 parent 1ab0770 commit 228127a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Some charts will also generate additional templates and docs based on other file
If your chart is dependent on external charts, you can update the dependencies by:

1. Set the dependency's version in Chart.yaml.
2. Update the Chart.lock file by running `make -C charts/&lt;the chart you are modifying&gt; build`.
2. Update the Chart.lock file by running `make -C charts/<the chart you are modifying> build`.

### Updating feature dependencies

Expand Down Expand Up @@ -110,7 +110,7 @@ chart and runs helm test as well.
To run the integration tests for the `k8s-monitoring` chart, use the following commands:

```bash
./scripts/run-integration-test.sh charts/k8s-monitoring/tests/integration/&lt;test dir&gt;
./scripts/run-integration-test.sh charts/k8s-monitoring/tests/integration/<test dir>
```

This will create a new Kubernetes cluster using kind, deploy any required dependencies, deploy the `k8s-monitoring` Helm
Expand Down
10 changes: 5 additions & 5 deletions charts/k8s-monitoring/docs/Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,17 +75,17 @@ To add a new feature, create a new Helm chart in the `charts` directory. The cha
its name. The following files are required for a feature chart:

- `templates/_module.alloy.tpl` - This file should contain a template function named
`feature.&lt;feature-slug&gt;.module` which should create an [Alloy module](https://grafana.com/docs/alloy/latest/get-started/modules/)
`feature.<feature-slug>.module` which should create an [Alloy module](https://grafana.com/docs/alloy/latest/get-started/modules/)
that wraps the configuration for your feature. It should expose any of these arguments as appropriate:
- `metrics_destination` - An argument that defines where scrape metrics should be delivered.
- `logs_destination` - An argument that defines where logs should be delivered.
- `traces_destination` - An argument that defines where traces should be delivered.
- `profiles_destination` - An argument that defines where profiles should be delivered.

- `templates/_notes.alloy.tpl` - This file should contain these template functions:
- `feature.&lt;feature-slug&gt;.notes.deployments` - This function returns a list of workloads that will be
- `feature.<feature-slug>.notes.deployments` - This function returns a list of workloads that will be
deployed to the Kubernetes Cluster by the feature.
- `feature.&lt;feature-slug&gt;.notes.task` - This function returns a 1-line summary of what this feature will do.
- `feature.&lt;feature-slug&gt;.notes.actions` - This function returns any prompts for the user to take additional
- `feature.<feature-slug>.notes.task` - This function returns a 1-line summary of what this feature will do.
- `feature.<feature-slug>.notes.actions` - This function returns any prompts for the user to take additional
action after deployment.
- `feature.&lt;feature-slug&gt;.summary` - This function a dictionary of settings, used for self-reporting metrics.
- `feature.<feature-slug>.summary` - This function a dictionary of settings, used for self-reporting metrics.
26 changes: 13 additions & 13 deletions charts/k8s-monitoring/docs/destinations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,30 +146,30 @@ destination configuration and documentation.

Several files are used for defining a destination:

- `destinations/&lt;destination slug&gt;-values.yaml` - The values file that defines the valid configuration options
- `destinations/<destination slug>-values.yaml` - The values file that defines the valid configuration options
for the destination. It is a YAML file in the style of a Helm chart values file. This file is used to generate
documentation and schema files that will validate the options when deploying.
- `templates/destinations/_destination_&lt;destination slug&gt;.tpl` - The template file that generates the
- `templates/destinations/_destination_<destination slug>.tpl` - The template file that generates the
destination configuration. This file is required to implement the following template functions:
- `destinations.&lt;destination slug&gt;.alloy` - Returns the Alloy configuration for the destination.
- `destinations.&lt;destination slug&gt;.secrets` - Returns a YAML list of values that should be considered secrets. This will control how the secret for this destination is generated and interfaced in the Alloy config.
- `destinations.&lt;destination slug&gt;.supports_metrics` - Returns true if the destination supports metrics.
- `destinations.&lt;destination slug&gt;.supports_logs` - Returns true if the destination supports logs.
- `destinations.&lt;destination slug&gt;.supports_traces` - Returns true if the destination supports traces.
- `destinations.&lt;destination slug&gt;.supports_profiles` - Returns true if the destination supports profiles.
- `destinations.&lt;destination slug&gt;.ecosystem` - Returns the telemetry data ecosystem.
- `destinations.&lt;destination slug&gt;.&lt;ecosystem&gt;.&lt;data type&gt;.target` - Returns the name of the Alloy target where telemetry data of the matching type and ecosystem should be sent.
- `destinations.<destination slug>.alloy` - Returns the Alloy configuration for the destination.
- `destinations.<destination slug>.secrets` - Returns a YAML list of values that should be considered secrets. This will control how the secret for this destination is generated and interfaced in the Alloy config.
- `destinations.<destination slug>.supports_metrics` - Returns true if the destination supports metrics.
- `destinations.<destination slug>.supports_logs` - Returns true if the destination supports logs.
- `destinations.<destination slug>.supports_traces` - Returns true if the destination supports traces.
- `destinations.<destination slug>.supports_profiles` - Returns true if the destination supports profiles.
- `destinations.<destination slug>.ecosystem` - Returns the telemetry data ecosystem.
- `destinations.<destination slug>.<ecosystem>.<data type>.target` - Returns the name of the Alloy target where telemetry data of the matching type and ecosystem should be sent.
Multiple target template functions can be made to support converting from one ecosystem to another.
- `docs/destinations/.doc_templates/&lt;destination slug&gt;.gotmpl` - The optional documentation template file for the
- `docs/destinations/.doc_templates/<destination slug>.gotmpl` - The optional documentation template file for the
destination. This file can include examples, usage instructions, and other information about the destination.

### Generated files

When using `make build`, the following files will be updated or generated:

- `docs/destinations/&lt;destination slug&gt;.md` - The documentation file for the destination. This file is generated
- `docs/destinations/<destination slug>.md` - The documentation file for the destination. This file is generated
from the destination values file and the destination template file.
- `values/destinations/&lt;destination slug&gt;.schema.json` - The JSON schema file for the destination values file. This
- `values/destinations/<destination slug>.schema.json` - The JSON schema file for the destination values file. This
file is generated from the destination values file.
- `templates/destinations/_destination_types.tpl` - This template file is generated with the list of all possible
destination types.

0 comments on commit 228127a

Please sign in to comment.