Add Prometheus doc #4276
Merged
Add Prometheus doc #4276
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eks-distro-bot
added
the
size/XL
Codecov Report
@@ Coverage Diff @@
## main #4276 +/- ##
==========================================
- Coverage 68.46% 68.45% -0.01%
==========================================
Files 404 404
Lines 32797 32809 +12
==========================================
+ Hits 22455 22461 +6
- Misses 8901 8905 +4
- Partials 1441 1443 +2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
chrisnegus
requested changes
Dec 2, 2022
| | [ADOT]({{< relref "./adot" >}}) | ADOT Collector is an AWS distribution of the OpenTelemetry Collector, which provides a vendor-agnostic solution to receive, process and export telemetry data. | [v0.21.1]({{< relref "./adot/v0.21.1.md" >}}) | https://github.com/aws-observability/aws-otel-collector | | ||
| | [Cert-manager]({{< relref "./cert-manager" >}}) | Cert-manager is a certificate manager for Kubernetes clusters. | [v1.9.1]({{< relref "./cert-manager/v1.9.1.md" >}}) | https://github.com/cert-manager/cert-manager | |
There was a problem hiding this comment.
Nice idea to reorganized based on alphabetical order!
| | server.persistentVolume.existingClaim | Specifies prometheus-server data Persistent Volume existing claim name. It requires `server.persistentVolume.enabled: true`. If defined, PVC must be created manually before volume will be bound | `""` | | ||
| | server.persistentVolume.size | Specifies prometheus-server data Persistent Volume size | `"8Gi"` | | ||
| | server.remoteRead | Specifies prometheus-server remote read configs. Refer to Prometheus docs [remote_read](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read) for more details | `[]` | | ||
| | server.remoteRead | Specifies prometheus-server remote write configs. Refer to Prometheus docs [remote_write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more details | `[]` | |
There was a problem hiding this comment.
Suggested change
| | server.remoteRead | Specifies prometheus-server remote write configs. Refer to Prometheus docs [remote_write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more details | `[]` | | |
| | server.remoteWrite | Specifies prometheus-server remote write configs. Refer to Prometheus docs [remote_write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more details | `[]` | |
I'm guessing this is what you mean.
| | server.persistentVolume.size | Specifies prometheus-server data Persistent Volume size | `"8Gi"` | | ||
| | server.remoteRead | Specifies prometheus-server remote read configs. Refer to Prometheus docs [remote_read](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read) for more details | `[]` | | ||
| | server.remoteRead | Specifies prometheus-server remote write configs. Refer to Prometheus docs [remote_write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more details | `[]` | | ||
| | server.replicaCount | Specifies the replicaCount for prometheus-server deployment / statefulSet. **Note `server.statefulSet.enabled` should be set to `true` if `server.replicaCount` is greater than `1`** | `1` | |
There was a problem hiding this comment.
Suggested change
| | server.replicaCount | Specifies the replicaCount for prometheus-server deployment / statefulSet. **Note `server.statefulSet.enabled` should be set to `true` if `server.replicaCount` is greater than `1`** | `1` | | |
| | server.replicaCount | Specifies the replicaCount for prometheus-server deployment / statefulSet. **Note:** `server.statefulSet.enabled` should be set to `true` if `server.replicaCount` is greater than `1` | `1` | |
Not required, but I like to just bold the "Note" part.
|
|
||
| {{% alert title="Important" color="warning" %}} | ||
| * Starting at `eksctl anywhere` version `v0.12.0`, packages on workload clusters are remotely managed by the management cluster. | ||
| * While following this guide to install packages on a workload cluster, please make sure the `kubeconfig` is pointing to the management cluster that was used to create the workload cluster. The only exception is the `kubectl create namespace` command below, which should be ran with `kubeconfig` pointing to the workload cluster. |
There was a problem hiding this comment.
Suggested change
| * While following this guide to install packages on a workload cluster, please make sure the `kubeconfig` is pointing to the management cluster that was used to create the workload cluster. The only exception is the `kubectl create namespace` command below, which should be ran with `kubeconfig` pointing to the workload cluster. | |
| * While following this guide to install packages on a workload cluster, please make sure the `kubeconfig` is pointing to the management cluster that was used to create the workload cluster. The only exception is the `kubectl create namespace` command below, which should be run with `kubeconfig` pointing to the workload cluster. |
There was a problem hiding this comment.
Thank you! I raised a separate PR #4279 to address this comment for other packages as well
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: TerryHowe The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available: aws/eks-anywhere-packages#639
The rendered view of main changes can be accessed at https://prometheus-doc-deploy.d234yjlc0qbnov.amplifyapp.com/docs/tasks/packages/prometheus/ and https://prometheus-doc-deploy.d234yjlc0qbnov.amplifyapp.com/docs/reference/packagespec/prometheus/v2.39.1/
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.