From ce0f2cb240f8503020c92e063300e83fb35ef33d Mon Sep 17 00:00:00 2001 From: paulfantom Date: Wed, 5 Aug 2020 14:16:13 +0200 Subject: [PATCH] fix docs references --- .github/ISSUE_TEMPLATE/bug.md | 2 +- .github/ISSUE_TEMPLATE/support.md | 2 +- Documentation/additional-scrape-config.md | 4 ++-- Documentation/user-guides/linting.md | 2 +- .../user-guides/monitoring-kubernetes-ingress.md | 6 +++--- Documentation/user-guides/storage.md | 2 +- README.md | 2 ++ RELEASE.md | 2 +- contrib/kube-prometheus/README.md | 12 ++++++------ helm/README.md | 2 +- 10 files changed, 19 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 7bdd18cc83..0ba931ab83 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -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 --> diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md index 7be39435f2..2bb2d69e6d 100644 --- a/.github/ISSUE_TEMPLATE/support.md +++ b/.github/ISSUE_TEMPLATE/support.md @@ -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 --> diff --git a/Documentation/additional-scrape-config.md b/Documentation/additional-scrape-config.md index 10541f0499..efd7732ac0 100644 --- a/Documentation/additional-scrape-config.md +++ b/Documentation/additional-scrape-config.md @@ -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) diff --git a/Documentation/user-guides/linting.md b/Documentation/user-guides/linting.md index 644f1dc27a..35453de67e 100644 --- a/Documentation/user-guides/linting.md +++ b/Documentation/user-guides/linting.md @@ -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 diff --git a/Documentation/user-guides/monitoring-kubernetes-ingress.md b/Documentation/user-guides/monitoring-kubernetes-ingress.md index d36f1b6fe7..b977aacce8 100644 --- a/Documentation/user-guides/monitoring-kubernetes-ingress.md +++ b/Documentation/user-guides/monitoring-kubernetes-ingress.md @@ -1,7 +1,7 @@
# Monitoring Kubernetes Ingress with Ambassador @@ -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`: diff --git a/Documentation/user-guides/storage.md b/Documentation/user-guides/storage.md index fe45002dff..51421dcbb5 100644 --- a/Documentation/user-guides/storage.md +++ b/Documentation/user-guides/storage.md @@ -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 diff --git a/README.md b/README.md index 527b66a06d..235679bf31 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/RELEASE.md b/RELEASE.md index 6d3560039e..404c009536 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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. diff --git a/contrib/kube-prometheus/README.md b/contrib/kube-prometheus/README.md index 200fa3109d..ee19ee34a0 100644 --- a/contrib/kube-prometheus/README.md +++ b/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?** @@ -9,12 +9,12 @@ 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. @@ -22,16 +22,16 @@ Users depending on kube-prometheus with jsonnet-bundler, should change this thei "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?** diff --git a/helm/README.md b/helm/README.md index 5814c8cda7..0cd398beca 100644 --- a/helm/README.md +++ b/helm/README.md @@ -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) \ No newline at end of file +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)