Skip to content

Commit 2530ebb

Browse files
Move introduction.md and installation.md to main repo
1 parent a0daad4 commit 2530ebb

File tree

4 files changed

+46
-60
lines changed

4 files changed

+46
-60
lines changed

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88
# Generated content to ignore (sorted alphabetically)
99

1010
/content/adopters.md
11-
/content/docs/getting-started/compatibility.md
12-
/content/docs/getting-started/design.md
11+
/content/docs/getting-started/*
1312
/content/docs/api-reference/*
1413
/content/docs/developer/*
1514
/content/docs/platform/*
1615
/content/docs/community/*
1716
/content/kube-prometheus/kube/*
1817

18+
!/content/docs/getting-started/_index.md
1919
!/content/docs/api-reference/_index.md
2020
!/content/docs/developer/_index.md
2121
!/content/docs/platform/_index.md

content/docs/getting-started/installation.md

+13-20
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Installing Prometheus Operator"
3-
description: "Installation guide listing all the installation methods of Prometheus Operator."
4-
date: 2020-11-16T13:59:39+01:00
5-
draft: false
6-
images: []
7-
menu:
8-
docs:
9-
parent: "getting-started"
102
weight: 102
113
toc: true
4+
title: Installing Prometheus Operator
5+
menu:
6+
docs:
7+
parent: getting-started
8+
images: []
9+
draft: false
10+
description: Installation guide listing all the installation methods of Prometheus Operator.
11+
date: "2020-11-16T13:59:39+01:00"
1212
---
1313

1414
There are different approaches to install Prometheus Operator in your Kubernetes cluster:
@@ -21,18 +21,13 @@ There are different approaches to install Prometheus Operator in your Kubernetes
2121

2222
For all the approaches listed on this page, you require access to a **Kubernetes cluster!** For this, you can check the official docs of Kubernetes available [here](https://kubernetes.io/docs/tasks/tools/).
2323

24-
Version `>=0.39.0` of the Prometheus Operator requires a Kubernetes
25-
cluster of version `>=1.16.0`. If you are just starting out with the
26-
Prometheus Operator, it is **highly recommended** to use the latest version. If
27-
you have an older version of Kubernetes and the Prometheus Operator running,
28-
we recommend upgrading Kubernetes first and then the Prometheus Operator.
24+
Version `>=0.39.0` of the Prometheus Operator requires a Kubernetes cluster of version `>=1.16.0`. If you are just starting out with the Prometheus Operator, it is **highly recommended** to use the latest version. If you have an older version of Kubernetes and the Prometheus Operator running, we recommend upgrading Kubernetes first and then the Prometheus Operator.
2925

3026
> Check the appropriate versions of each of the components in the [Compatibility]({{<ref "compatibility">}}) page.
3127
3228
### Install using YAML files
3329

34-
The first step is to install the operator's Custom Resource Definitions (CRDs) as well
35-
as the operator itself with the required RBAC resources.
30+
The first step is to install the operator's Custom Resource Definitions (CRDs) as well as the operator itself with the required RBAC resources.
3631

3732
Run the following commands to install the CRDs and deploy the operator in the `default` namespace:
3833

@@ -49,8 +44,7 @@ kubectl wait --for=condition=Ready pods -l app.kubernetes.io/name=prometheus-op
4944

5045
### Install using Kube-Prometheus
5146

52-
The easiest way of starting with the Prometheus Operator is by deploying it as part of kube-prometheus.
53-
kube-prometheus deploys the Prometheus Operator and already schedules a Prometheus called `prometheus-k8s` with alerts and rules by default.
47+
The easiest way of starting with the Prometheus Operator is by deploying it as part of kube-prometheus. kube-prometheus deploys the Prometheus Operator and already schedules a Prometheus called `prometheus-k8s` with alerts and rules by default.
5448

5549
We are going to deploy a compiled version of the Kubernetes [manifests](https://github.com/prometheus-operator/kube-prometheus/tree/main/manifests).
5650

@@ -76,8 +70,7 @@ until kubectl get servicemonitors --all-namespaces ; do date; sleep 1; echo "";
7670
kubectl create -f manifests/
7771
```
7872

79-
We create the namespace and CustomResourceDefinitions first to avoid race conditions when deploying the monitoring components.
80-
Alternatively, the resources in both folders can be applied with a single command:
73+
We create the namespace and CustomResourceDefinitions first to avoid race conditions when deploying the monitoring components. Alternatively, the resources in both folders can be applied with a single command:
8174

8275
```
8376
kubectl create -f manifests/setup -f manifests
@@ -96,11 +89,11 @@ If you're done experimenting with kube-prometheus and the Prometheus Operator yo
9689
```shell
9790
kubectl delete --ignore-not-found=true -f manifests/ -f manifests/setup
9891
```
92+
9993
### Install Using Helm Chart
10094

10195
Install the [Kube-Prometheus-Stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) helm chart which provides a collection of Kubernetes manifests, [Grafana](https://grafana.com/) dashboards, and [Prometheus rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) combined with documentation and scripts to provide easy to operate end-to-end Kubernetes cluster monitoring with [Prometheus](https://prometheus.io/) using the Prometheus Operator.
10296

10397
To see more details, please check the [chart's README](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack#kube-prometheus-stack).
10498

10599
> This helm chart is no longer part of Prometheus-Operator and is now maintained by [Prometheus Community Helm Charts](https://github.com/prometheus-community/helm-charts).
106-
+27-37
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: "Introduction"
3-
description: "The Prometheus Operator provides Kubernetes native deployment and management of Prometheus and related monitoring components"
4-
lead: ""
5-
date: 2020-10-06T08:48:57+00:00
6-
lastmod: 2020-10-06T08:48:57+00:00
7-
draft: false
8-
images: []
9-
menu:
10-
docs:
11-
parent: "getting-started"
122
weight: 101
133
toc: true
4+
title: Introduction
5+
menu:
6+
docs:
7+
parent: getting-started
8+
lead: ""
9+
lastmod: "2020-10-06T08:48:57+00:00"
10+
images: []
11+
draft: false
12+
description: The Prometheus Operator provides Kubernetes native deployment and management of Prometheus and related monitoring components
13+
date: "2020-10-06T08:48:57+00:00"
1414
---
1515

16-
Prometheus Operator is a [Kubernetes Operator](https://github.com/cncf/tag-app-delivery/blob/main/operator-wg/whitepaper/Operator-WhitePaper_v1-0.md#foundation) that provides Kubernetes native deployment and management of [Prometheus](https://prometheus.io/) and related monitoring components.
16+
Prometheus Operator is a [Kubernetes Operator](https://github.com/cncf/tag-app-delivery/blob/main/operator-wg/whitepaper/Operator-WhitePaper_v1-0.md#foundation) that provides Kubernetes native deployment and management of [Prometheus](https://prometheus.io/) and related monitoring components.
1717

1818
The Prometheus operator includes, but is not limited to, the following features:
1919

@@ -23,7 +23,7 @@ The Prometheus operator includes, but is not limited to, the following features:
2323

2424
- **Prometheus Target Configuration**: Automatically generate monitoring target configurations based on familiar Kubernetes label queries; no need to learn a Prometheus specific configuration language.
2525

26-
Prometheus Operator provides a set of Custom Resource Definitions(CRDs) that allows you to configure your Prometheus and related instances. Currently, the CRDs provided by Prometheus Operator are:
26+
Prometheus Operator provides a set of Custom Resource Definitions(CRDs) that allows you to configure your Prometheus and related instances. Currently, the CRDs provided by Prometheus Operator are:
2727

2828
- Prometheus
2929
- Alertmanager
@@ -55,36 +55,26 @@ By now, you have the basic idea about Prometheus Operator!!
5555
Take a look at these guides to get into action with Prometheus Operator.
5656

5757
<!-- Getting-Started -->
58-
{{<link-card
59-
title="Getting-Started"
60-
href="https://prometheus-operator.dev/docs/getting-started/introduction/"
61-
description="Get started with Prometheus-Operator."
62-
>}}
58+
59+
{{<
60+
link-card title="Getting-Started" href="https://prometheus-operator.dev/docs/getting-started/introduction/" description="Get started with Prometheus-Operator.">}}
6361

6462
<!-- API -->
65-
{{<link-card
66-
title="API Reference"
67-
href="https://prometheus-operator.dev/docs/api-reference/api/"
68-
description="Reference for different fields of Custom Resources in Prometheus-Operator."
69-
>}}
63+
64+
{{<
65+
link-card title="API Reference" href="https://prometheus-operator.dev/docs/api-reference/api/" description="Reference for different fields of Custom Resources in Prometheus-Operator.">}}
7066

7167
<!-- Platform Guide -->
72-
{{<link-card
73-
title="Platform Guide"
74-
href="https://prometheus-operator.dev/docs/platform/webhook/"
75-
description="Set up, configure and manage instances of Prometheus-Operator, Prometheus, Alertmanager and ThanosRuler resources."
76-
>}}
68+
69+
{{<
70+
link-card title="Platform Guide" href="https://prometheus-operator.dev/docs/platform/webhook/" description="Set up, configure and manage instances of Prometheus-Operator, Prometheus, Alertmanager and ThanosRuler resources.">}}
7771

7872
<!-- Developer Guide -->
79-
{{<link-card
80-
title="Developer Guide"
81-
href="https://prometheus-operator.dev/docs/developer/getting-started/"
82-
description="Learn how to configure scraping, alerting, and recording rules for your applications."
83-
>}}
73+
74+
{{<
75+
link-card title="Developer Guide" href="https://prometheus-operator.dev/docs/developer/getting-started/" description="Learn how to configure scraping, alerting, and recording rules for your applications.">}}
8476

8577
<!-- Community -->
86-
{{<link-card
87-
title="Community"
88-
href="https://prometheus-operator.dev/docs/community/contributing/"
89-
description="Join and interact with Prometheus-Operator community."
90-
>}}
78+
79+
{{<
80+
link-card title="Community" href="https://prometheus-operator.dev/docs/community/contributing/" description="Join and interact with Prometheus-Operator community.">}}

synchronize.sh

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ rm -rf repos/
66
mkdir repos/
77

88
if [[ -z "$USE_LOCAL_REPOSITORIES" ]]; then
9-
git clone https://github.com/prometheus-operator/prometheus-operator -b main --depth 1 repos/prometheus-operator
9+
# git clone https://github.com/prometheus-operator/prometheus-operator -b main --depth 1 repos/prometheus-operator
10+
git clone https://github.com/AshwinSriram11/prometheus-operator -b fmt-docs repos/prometheus-operator
1011
git clone https://github.com/prometheus-operator/kube-prometheus -b main --depth 1 repos/kube-prometheus
1112
else
1213
ln -s ../../prometheus-operator repos/prometheus-operator
@@ -22,6 +23,8 @@ cp repos/prometheus-operator/ADOPTERS.md content/adopters.md
2223
cp -r repos/prometheus-operator/Documentation/img static/img
2324

2425
# getting-started section
26+
cp repos/prometheus-operator/Documentation/introduction.md content/docs/getting-started/introduction.md
27+
cp repos/prometheus-operator/Documentation/installation.md content/docs/getting-started/installation.md
2528
cp repos/prometheus-operator/Documentation/compatibility.md content/docs/getting-started/compatibility.md
2629
cp repos/prometheus-operator/Documentation/design.md content/docs/getting-started/design.md
2730

0 commit comments

Comments
 (0)