diff --git a/README.md b/README.md index 98d443f9c3fa..a2338be6f64f 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ Grafana Cloud Agent is an observability data collector optimized for sending metrics and log data to [Grafana Cloud](https://grafana.com/products/cloud/). -Users of Prometheus cloud storage vendors with a single Prometheus instance can -struggle sending their data at massive scale (millions of active series): -Prometheus is sometimes called a single point of failure that generally requires +Users of Prometheus cloud storage vendors with a single Prometheus instance can +struggle sending their data at massive scale (millions of active series): +Prometheus is sometimes called a single point of failure that generally requires a giant machine with a lot of resources allocated to it. -The Grafana Cloud Agent uses the same code as Prometheus, but tackles these issues -by only using the most relevant parts of Prometheus for interaction with hosted -metrics: +The Grafana Cloud Agent uses the same code as Prometheus, but tackles these issues +by only using the most relevant parts of Prometheus for interaction with hosted +metrics: 1. Service Discovery 2. Scraping @@ -39,11 +39,11 @@ trade-offs have been made: - When sharding the Agent, if your node has problems that interrupt metric availability, metrics tracking that node won't be sent for alerting on. -While the Agent can't use recording rules and alerts, `remote_write` systems such -as Cortex currently support server-side rules and alerts. Note that this trade-off -means that reliability of alerts are tied to the reliability of the remote system -and alerts will be delayed at least by the time it takes for samples to reach -the remote system. +While the Agent can't use recording rules and alerts, `remote_write` systems such +as Cortex currently support server-side rules and alerts. Note that this trade-off +means that reliability of alerts are tied to the reliability of the remote system +and alerts will be delayed at least by the time it takes for samples to reach +the remote system. ## Roadmap @@ -59,7 +59,7 @@ Kubernetes install script. Simply copy and paste the following line in your terminal: ``` -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/grafana/agent/master/production/kubernetes/install.sh)" | kubectl apply -f - +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/grafana/agent/release/production/kubernetes/install.sh)" | kubectl apply -f - ``` Other installation methods can be found in our diff --git a/docs/maintaining.md b/docs/maintaining.md index febebe2d8795..2dad2ebbe658 100644 --- a/docs/maintaining.md +++ b/docs/maintaining.md @@ -83,3 +83,12 @@ Once the steps are completed, you can publish your draft! 3. Optionally, have other team members review the release draft so you feel comfortable with it. 4. Publish the release! + +## Updating Release Branch + +The `release` branch should always point at the SHA of the commit of the latest +release tag. This is used so that the install instructions can be generic and +made to always install the latest released version. + +Update the release branch by fast-forwarding it to the appropriate SHA (matching +the latest tag) and pushing it back upstream.