Navigation Menu

Skip to content

Commit

Permalink
fix docs references
Browse files Browse the repository at this point in the history
  • Loading branch information
paulfantom committed Aug 5, 2020
1 parent 4cd5312 commit ce0f2cb
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Expand Up @@ -10,7 +10,7 @@ Feel free to ask questions in #prometheus-operator on Kubernetes Slack!
Note: This repository is about prometheus-operator itself, if you have questions about:
- helm installation, go to https://github.com/helm/charts repository
- kube-prometheus setup, go to https://github.com/coreos/kube-prometheus
- kube-prometheus setup, go to https://github.com/prometheus-operator/kube-prometheus
-->

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/support.md
Expand Up @@ -10,7 +10,7 @@ Feel free to ask questions in #prometheus-operator on Kubernetes Slack!
Note: This repository is about prometheus-operator itself, if you have questions about:
- helm installation, go to https://github.com/helm/charts repository
- kube-prometheus setup, go to https://github.com/coreos/kube-prometheus
- kube-prometheus setup, go to https://github.com/prometheus-operator/kube-prometheus
-->

Expand Down
4 changes: 2 additions & 2 deletions Documentation/additional-scrape-config.md
Expand Up @@ -70,5 +70,5 @@ NOTE: Use only one secret for ALL additional scrape configurations.

## Additional References

* [Prometheus Spec](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#prometheusspec)
* [Additional Scrape Configs](https://github.com/coreos/prometheus-operator/tree/master/example/additional-scrape-configs)
* [Prometheus Spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#prometheusspec)
* [Additional Scrape Configs](https://github.com/prometheus-operator/prometheus-operator/tree/master/example/additional-scrape-configs)
2 changes: 1 addition & 1 deletion Documentation/user-guides/linting.md
Expand Up @@ -4,7 +4,7 @@ This document describes how to use the standalone linting tool to validate your

## Getting linter

To use the linter either get it with `go get -u github.com/coreos/prometheus-operator/cmd/po-lint` and executable is `$GOPATH/bin/po-lint`, or use the container image from `quay.io/coreos/po-tooling` and executable is `/go/bin/po-lint`.
To use the linter either get it with `go get -u github.com/prometheus-operator/prometheus-operator/cmd/po-lint` and executable is `$GOPATH/bin/po-lint`, or use the container image from `quay.io/coreos/po-tooling` and executable is `/go/bin/po-lint`.

## Using linter

Expand Down
6 changes: 3 additions & 3 deletions Documentation/user-guides/monitoring-kubernetes-ingress.md
@@ -1,7 +1,7 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.<br><br>
This documentation is for an alpha feature. For questions and feedback on the Prometheus OCS Alpha program, email <a href="mailto:tectonic-alpha-feedback@coreos.com">tectonic-alpha-feedback@coreos.com</a>.
This documentation is for an alpha feature.
</div>

# Monitoring Kubernetes Ingress with Ambassador
Expand Down Expand Up @@ -94,10 +94,10 @@ You now have an application running in Kubernetes and exposed to the internet.
## Deploy Prometheus
Now that we have an application running and exposed by Ambassador, we need to configure Prometheus to scrape the metrics from Ambassador. The Prometheus Operator gives us a way to deploy and manage Prometheus deployments using Kubernetes-style resources

The Prometheus Operator creates Kubernetes Custom Resource Definitions (CRDs) so we can manage our Prometheus deployment using Kubernetes-style declarative YAML manifests. To deploy the Prometheus Operator, you can clone the [repository](https://github.com/coreos/prometheus-operator) and follow the instructions in the README. You can also just create it with `kubectl`:
The Prometheus Operator creates Kubernetes Custom Resource Definitions (CRDs) so we can manage our Prometheus deployment using Kubernetes-style declarative YAML manifests. To deploy the Prometheus Operator, you can clone the [repository](https://github.com/prometheus-operator/prometheus-operator) and follow the instructions in the README. You can also just create it with `kubectl`:

```
kubectl apply -f https://raw.githubusercontent.com/coreos/prometheus-operator/master/bundle.yaml
kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/master/bundle.yaml
```

Once the Prometheus operator is running, we need to create a Prometheus instance. The Prometheus Operator manages Prometheus deployments with the `Prometheus` CRD. To create a Prometheus instance and Kubernetes service, copy the following YAML to a file called `prometheus.yaml` and deploy it with `kubectl`:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/user-guides/storage.md
Expand Up @@ -30,7 +30,7 @@ parameters:
For best results, use volumes that have high I/O throughput. These examples use SSD EBS volumes. Read the Kubernetes [Persistent Volumes][persistent-volumes] documentation to adapt this `StorageClass` to your needs.

The `StorageClass` that was created can be specified in the `storage` section in the `Prometheus` resource (note that if you're using [kube-prometheus](https://github.com/coreos/kube-prometheus), then instead of making the following change to your `Prometheus` resource, see the [prometheus-pvc.jsonnet](https://github.com/coreos/kube-prometheus/blob/master/examples/prometheus-pvc.jsonnet) example).
The `StorageClass` that was created can be specified in the `storage` section in the `Prometheus` resource (note that if you're using [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus), then instead of making the following change to your `Prometheus` resource, see the [prometheus-pvc.jsonnet](https://github.com/prometheus-operator/kube-prometheus/blob/master/examples/prometheus-pvc.jsonnet) example).

[embedmd]:# (../../example/storage/persisted-prometheus.yaml)
```yaml
Expand Down
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -5,6 +5,8 @@

**Project status: *beta*** Not all planned features are completed. The API, spec, status and other user facing objects may change, but in a backward compatible way.

Note: Project was previously known as coreos/prometheus-operator.

## Overview

The Prometheus Operator provides [Kubernetes](https://kubernetes.io/) native deployment and management of
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Expand Up @@ -70,6 +70,6 @@ Signed tag with a GPG key is appreciated, but in case you can't add a GPG key to

Our CI pipeline will automatically push a new docker image to quay.io.

Go to https://github.com/coreos/prometheus-operator/releases/new, associate the new release with the before pushed tag, paste in changes made to `CHANGELOG.md` and click "Publish release".
Go to https://github.com/prometheus-operator/prometheus-operator/releases/new, associate the new release with the before pushed tag, paste in changes made to `CHANGELOG.md` and click "Publish release".

Take a breath. You're done releasing.
12 changes: 6 additions & 6 deletions contrib/kube-prometheus/README.md
@@ -1,6 +1,6 @@
# kube-prometheus

## WARNING: kube-prometheus moved to [coreos/kube-prometheus](https://github.com/coreos/kube-prometheus)!
## WARNING: kube-prometheus moved to [prometheus-operator/kube-prometheus](https://github.com/prometheus-operator/kube-prometheus)!

**Why did you move it?**

Expand All @@ -9,29 +9,29 @@ Moving kube-prometheus into its own repository is going to allow us to move more
As an example, we are now going to publish versioned kube-prometheus releases, something that was not possible before.

Take a look at this issue for more information:
https://github.com/coreos/prometheus-operator/issues/2553
https://github.com/prometheus-operator/prometheus-operator/issues/2553


**What do I need to do?**

Simply go to [coreos/kube-prometheus](https://github.com/coreos/kube-prometheus) and make use of it the same way you did before.
Simply go to [prometheus-operator/kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) and make use of it the same way you did before.

Users depending on kube-prometheus with jsonnet-bundler, should change this their `jsonnetfile.json` and `jsonnetfile.lock.json` to point to the correct repository.

```diff
"name": "kube-prometheus",
"source": {
"git": {
- "remote": "https://github.com/coreos/prometheus-operator",
- "remote": "https://github.com/prometheus-operator/prometheus-operator",
- "subdir": "contrib/kube-prometheus/jsonnet/kube-prometheus"
+ "remote": "https://github.com/coreos/kube-prometheus",
+ "remote": "https://github.com/prometheus-operator/kube-prometheus",
+ "subdir": "jsonnet/kube-prometheus"
}
},
"version": "master"
```

*Note: We needed to merge the two repositories and commit hashes are not the same anymore, when referencing coreos/kube-prometheus.*
*Note: We needed to merge the two repositories and commit hashes are not the same anymore, when referencing prometheus-operator/kube-prometheus.*

**You still have questions why it moved?**

Expand Down
2 changes: 1 addition & 1 deletion helm/README.md
Expand Up @@ -9,4 +9,4 @@ It is still possible to run multiple prometheus instances on a single cluster -

Issues and pull requests should be tracked using the [helm/charts](https://github.com/helm/charts) repository.

You can check out the tickets for this change [here](https://github.com/coreos/prometheus-operator/issues/592) and [here](https://github.com/helm/charts/pull/6765)
You can check out the tickets for this change [here](https://github.com/prometheus-operator/prometheus-operator/issues/592) and [here](https://github.com/helm/charts/pull/6765)

0 comments on commit ce0f2cb

Please sign in to comment.