Skip to content

Commit 0aff809

Browse files
authored
use h1 tags to not render titles in sidebar (#626)
1 parent 2c3c7fd commit 0aff809

File tree

12 files changed

+38
-39
lines changed

12 files changed

+38
-39
lines changed

docs/administrator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Administrator Guide
1+
<h1>Administrator Guide</h1>
22

33
Learn how to configure and manage the Postgres Operator in your Kubernetes (K8s)
44
environment.

docs/developer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Developer Guide
1+
<h1>Developer Guide</h1>
22

33
Read this guide if you want to debug the operator, fix bugs or contribute new
44
features and tests.

docs/gsoc-2019/ideas.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1+
<h1>Google Summer of Code 2019</h1>
12

2-
# Google Summer of Code 2019
3+
## Applications steps
34

4-
## Applications steps
5-
6-
1. Please carefully read the official [Google Summer of Code Student Guide](https://google.github.io/gsocguides/student/)
5+
1. Please carefully read the official [Google Summer of Code Student Guide](https://google.github.io/gsocguides/student/)
76
2. Join the #postgres-operator slack channel under [Postgres Slack](https://postgres-slack.herokuapp.com) to introduce yourself to the community and get quick feedback on your application.
87
3. Select a project from the list of ideas below or propose your own.
98
4. Write a proposal draft. Please open an issue with the label `gsoc2019_application` in the [operator repository](https://github.com/zalando/postgres-operator/issues) so that the community members can publicly review it. See proposal instructions below for details.
109
5. Submit proposal and the proof of enrollment before April 9 2019 18:00 UTC through the web site of the Program.
1110

12-
## Project ideas
11+
## Project ideas
1312

1413

15-
### Place database pods into the "Guaranteed" Quality-of-Service class
14+
### Place database pods into the "Guaranteed" Quality-of-Service class
1615

1716
* **Description**: Kubernetes runtime does not kill pods in this class on condition they stay within their resource limits, which is desirable for the DB pods serving production workloads. To be assigned to that class, pod's resources must equal its limits. The task is to add the `enableGuaranteedQoSClass` or the like option to the Postgres manifest and the operator configmap that forcibly re-write pod resources to match the limits.
1817
* **Recommended skills**: golang, basic Kubernetes abstractions
@@ -21,44 +20,44 @@
2120

2221
### Implement the kubectl plugin for the Postgres CustomResourceDefinition
2322

24-
* **Description**: [kubectl plugins](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) enable extending the Kubernetes command-line client `kubectl` with commands to manage custom resources. The task is to design and implement a plugin for the `kubectl postgres` command,
23+
* **Description**: [kubectl plugins](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) enable extending the Kubernetes command-line client `kubectl` with commands to manage custom resources. The task is to design and implement a plugin for the `kubectl postgres` command,
2524
that can enable, for example, correct deletion or major version upgrade of Postgres clusters.
2625
* **Recommended skills**: golang, shell scripting, operational experience with Kubernetes
2726
* **Difficulty**: moderate to medium, depending on the plugin design
2827
* **Mentor(s)**: Felix Kunde [@FxKu](https://github.com/fxku), Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
2928

3029
### Implement the openAPIV3Schema for the Postgres CRD
3130

32-
* **Description**: at present the operator validates a database manifest on its own.
31+
* **Description**: at present the operator validates a database manifest on its own.
3332
It will be helpful to reject erroneous manifests before they reach the operator using the [native Kubernetes CRD validation](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#validation). It is up to the student to decide whether to write the schema manually or to adopt existing [schema generator developed for the Prometheus project](https://github.com/ant31/crd-validation).
3433
* **Recommended skills**: golang, JSON schema
3534
* **Difficulty**: medium
36-
* **Mentor(s)**: Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
35+
* **Mentor(s)**: Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
3736
* **Issue**: [#388](https://github.com/zalando/postgres-operator/issues/388)
3837

3938
### Design a solution for the local testing of the operator
4039

4140
* **Description**: The current way of testing is to run minikube, either manually or with some tooling around it like `/run-operator_locally.sh` or Vagrant. This has at least three problems:
42-
First, minikube is a single node cluster, so it is unsuitable for testing vital functions such as pod migration between nodes. Second, minikube starts slowly; that prolongs local testing.
41+
First, minikube is a single node cluster, so it is unsuitable for testing vital functions such as pod migration between nodes. Second, minikube starts slowly; that prolongs local testing.
4342
Third, every contributor needs to come up with their own solution for local testing. The task is to come up with a better option which will enable us to conveniently and uniformly run e2e tests locally / potentially in Travis CI.
4443
A promising option is the Kubernetes own [kind](https://github.com/kubernetes-sigs/kind)
4544
* **Recommended skills**: Docker, shell scripting, basic Kubernetes abstractions
4645
* **Difficulty**: medium to hard depending on the selected desing
47-
* **Mentor(s)**: Dmitry Dolgov [@erthalion](https://github.com/erthalion), Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
46+
* **Mentor(s)**: Dmitry Dolgov [@erthalion](https://github.com/erthalion), Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
4847
* **Issue**: [#475](https://github.com/zalando/postgres-operator/issues/475)
4948

5049
### Detach a Postgres cluster from the operator for maintenance
5150

52-
* **Description**: sometimes a Postgres cluster requires manual maintenance. During such maintenance the operator should ignore all the changes manually applied to the cluster.
53-
Currently the only way to achieve this behavior is to shutdown the operator altogether, for instance by scaling down the operator's own deployment to zero pods. That approach evidently affects all Postgres databases under the operator control and thus is highly undesirable in production Kubernetes clusters. It would be much better to be able to detach only the desired Postgres cluster from the operator for the time being and re-attach it again after maintenance.
51+
* **Description**: sometimes a Postgres cluster requires manual maintenance. During such maintenance the operator should ignore all the changes manually applied to the cluster.
52+
Currently the only way to achieve this behavior is to shutdown the operator altogether, for instance by scaling down the operator's own deployment to zero pods. That approach evidently affects all Postgres databases under the operator control and thus is highly undesirable in production Kubernetes clusters. It would be much better to be able to detach only the desired Postgres cluster from the operator for the time being and re-attach it again after maintenance.
5453
* **Recommended skills**: golang, architecture of a Kubernetes operator
5554
* **Difficulty**: hard - requires significant modification of the operator's internals and careful consideration of the corner cases.
56-
* **Mentor(s)**: Dmitry Dolgov [@erthalion](https://github.com/erthalion), Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
55+
* **Mentor(s)**: Dmitry Dolgov [@erthalion](https://github.com/erthalion), Sergey Dudoladov [@sdudoladov](https://github.com/sdudoladov)
5756
* **Issue**: [#421](https://github.com/zalando/postgres-operator/issues/421)
5857

5958
### Propose your own idea
6059

61-
Feel free to come up with your own ideas. For inspiration,
62-
see [our bug tracker](https://github.com/zalando/postgres-operator/issues),
63-
the [official `CustomResouceDefinition` docs](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/)
64-
and [other operators](https://github.com/operator-framework/awesome-operators).
60+
Feel free to come up with your own ideas. For inspiration,
61+
see [our bug tracker](https://github.com/zalando/postgres-operator/issues),
62+
the [official `CustomResouceDefinition` docs](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/)
63+
and [other operators](https://github.com/operator-framework/awesome-operators).

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Concepts
1+
<h1>Concepts</h1>
22

33
The Postgres [operator](https://coreos.com/blog/introducing-operators.html)
44
manages PostgreSQL clusters on Kubernetes (K8s):

docs/operator-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Postgres Operator UI
1+
<h1>Postgres Operator UI</h1>
22

33
The Postgres Operator UI provides a graphical interface for a convenient
44
database-as-a-service user experience. Once the operator is set up by database

docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Quickstart
1+
<h1>Quickstart</h1>
22

33
This guide aims to give you a quick look and feel for using the Postgres
44
Operator on a local Kubernetes environment.
@@ -55,7 +55,7 @@ kubectl create -f manifests/postgres-operator.yaml # deployment
5555
```
5656

5757
There is a [Kustomization](https://github.com/kubernetes-sigs/kustomize)
58-
manifest that [combines the mentioned resources](../manifests/kustomization.yaml) -
58+
manifest that [combines the mentioned resources](../manifests/kustomization.yaml) -
5959
it can be used with kubectl 1.14 or newer as easy as:
6060

6161
```bash

docs/reference/cluster_manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cluster manifest reference
1+
<h1>Cluster manifest reference</h1>
22

33
Individual Postgres clusters are described by the Kubernetes *cluster manifest*
44
that has the structure defined by the `postgresql` CRD (custom resource

docs/reference/command_line_and_environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ flags](https://godoc.org/github.com/golang/glog) are also supported. For
2828
instance, one may want to add `-alsologtostderr` and `-v=8` to debug the
2929
operator REST calls.
3030

31-
## Environment variables
31+
# Environment variables
3232

3333
The following environment variables are accepted by the operator:
3434

docs/reference/operator_parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configuration parameters
1+
<h1>Configuration parameters</h1>
22

33
There are two mutually-exclusive methods to set the Postgres Operator
44
configuration.

docs/user.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# User Guide
1+
<h1>User Guide</h1>
22

33
Learn how to work with the Postgres Operator in a Kubernetes (K8s) environment.
44

0 commit comments

Comments
 (0)