Skip to content

Commit a80c873

Browse files
tjmoore4tjmoore4
committed
Prep repo for public availability
This commit updates the README file, adds the issue submission templates and adds a 'support' page to the documenation. Issue: [sc-15298]
1 parent c67b2d9 commit a80c873

File tree

6 files changed

+258
-2
lines changed

6 files changed

+258
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Report a Bug
3+
about: Found an issue? Let us fix it.
4+
---
5+
6+
Please ensure you do the following when reporting a bug:
7+
8+
- [ ] Provide a concise description of what the bug is.
9+
- [ ] Provide information about your environment.
10+
- [ ] Provide clear steps to reproduce the bug.
11+
- [ ] Attach applicable logs. Please do not attach screenshots showing logs
12+
unless you are unable to copy and paste the log data.
13+
- [ ] Ensure any code / output examples are
14+
[properly formatted](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code)
15+
for legibility.
16+
17+
An incomplete bug report can lead to delays in resolving the issue or the closing
18+
of a ticket, so please be as detailed as possible.
19+
20+
If you are looking for
21+
[general support](https://access.crunchydata.com/documentation/postgres-operator/latest/support/),
22+
please view the
23+
[support](https://access.crunchydata.com/documentation/postgres-operator/latest/support/)
24+
page for where you can ask questions.
25+
26+
Thanks for reporting the issue, we're looking forward to helping you!
27+
28+
## Overview
29+
30+
Add a concise description of what the bug is.
31+
32+
## Environment
33+
34+
Please provide the following details:
35+
36+
- OS Version: (`RedHat 8.5`, `Ubuntu 20.04.4`, `macOS 11`, etc)
37+
- Platform: (`Kubernetes`, `OpenShift`, `Rancher`, `GKE`, `EKS`, `AKS`, etc)
38+
- Platform Version: (e.g. `1.22.1`, `4.9.1`)
39+
- `pgo` CLI Version: (e.g. `v0.1`)
40+
- PGO Operator Image Tag: (e.g. `ubi8-5.2.0-0`)
41+
- Postgres Version (e.g. `14`)
42+
- Storage: (e.g. `hostpath`, `nfs`, or the name of your storage class)
43+
44+
## Steps to Reproduce
45+
46+
### REPRO
47+
48+
Provide steps to get to the error condition:
49+
50+
1. Run `...`
51+
1. Do `...`
52+
1. Try `...`
53+
54+
### EXPECTED
55+
56+
1. Provide the behavior that you expected.
57+
58+
### ACTUAL
59+
60+
1. Describe what actually happens
61+
62+
## Logs
63+
64+
Please provided appropriate log output or any configuration files that may help troubleshoot the issue. **DO NOT** include sensitive information, such as passwords.
65+
66+
## Additional Information
67+
68+
Please provide any additional information that may be helpful.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Feature Request
3+
about: Help us improve PGO!
4+
---
5+
6+
Have an idea to improve PGO? We'd love to hear it! We're going to need some
7+
information from you to learn more about your feature requests.
8+
9+
Please be sure you've done the following:
10+
11+
- [ ] Provide a concise description of your feature request.
12+
- [ ] Describe your use case. Detail the problem you are trying to solve.
13+
- [ ] Describe how you envision that the feature would work.
14+
- [ ] Provide general information about your current PGO environment.
15+
16+
## Overview
17+
18+
Provide a concise description of your feature request.
19+
20+
## Use Case
21+
22+
Describe your use case. Why do you want this feature? What problem will it solve?
23+
Why will it help you? Why will it make it easier to use PGO?
24+
25+
## Desired Behavior
26+
27+
Describe how the feature would work. How do you envision interfacing with it?
28+
29+
## Environment
30+
31+
Tell us about your environment:
32+
33+
Please provide the following details:
34+
35+
- OS Version: (`RedHat 8.5`, `Ubuntu 20.04.4`, `macOS 11`, etc)
36+
- Platform: (`Kubernetes`, `OpenShift`, `Rancher`, `GKE`, `EKS`, `AKS`, etc)
37+
- Platform Version: (e.g. `1.22.1`, `4.9.1`)
38+
- `pgo` CLI Version: (e.g. `v0.1`)
39+
- PGO Operator Image Tag: (e.g. `ubi8-5.2.0-0`)
40+
- Postgres Version (e.g. `14`)
41+
- Storage: (e.g. `hostpath`, `nfs`, or the name of your storage class)
42+
- Number of Postgres clusters: (`XYZ`)
43+
44+
## Additional Information
45+
46+
Please provide any additional information that may be helpful.

‎.github/ISSUE_TEMPLATE/support---question-and-answer.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Support
3+
about: "Learn how to interact with the PGO community"
4+
---
5+
6+
If you believe you have found have found a bug, please open up
7+
[Bug Report](https://github.com/CrunchyData/postgres-operator-client/issues/new?template=bug_report.md)
8+
9+
If you have a feature request, please open up a
10+
[Feature Request](https://github.com/CrunchyData/postgres-operator-client/issues/new?template=feature_request.md)
11+
12+
You can find information about general PGO
13+
[support](https://access.crunchydata.com/documentation/postgres-operator-client/latest/support/) at:
14+
15+
[https://access.crunchydata.com/documentation/postgres-operator-client/latest/support/](https://access.crunchydata.com/documentation/postgres-operator-client/latest/support/)
16+
17+
## Questions
18+
19+
For questions that are neither bugs nor feature requests, please be sure to
20+
21+
- [ ] Provide information about your environment (see below for more information).
22+
- [ ] Provide any steps or other relevant details related to your question.
23+
- [ ] Attach logs, where applicable. Please do not attach screenshots showing logs unless you are unable to copy and paste the log data.
24+
- [ ] Ensure any code / output examples are [properly formatted](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code) for legibility.
25+
26+
Besides Pod logs, logs may also be found in the `/pgdata/pg<MAJOR_VERSION>/log` directory on your Postgres instance.
27+
28+
If you are looking for [general support](https://access.crunchydata.com/documentation/postgres-operator/latest/support/), please view the [support](https://access.crunchydata.com/documentation/postgres-operator/latest/support/) page for where you can ask questions.
29+
30+
### Environment
31+
32+
Please provide the following details:
33+
34+
- OS Version: (`RedHat 8.5`, `Ubuntu 20.04.4`, `macOS 11`, etc)
35+
- Platform: (`Kubernetes`, `OpenShift`, `Rancher`, `GKE`, `EKS`, `AKS`, etc)
36+
- Platform Version: (e.g. `1.22.1`, `4.9.1`)
37+
- `pgo` CLI Version: (e.g. `v0.1`)
38+
- PGO Operator Image Tag: (e.g. `ubi8-5.2.0-0`)
39+
- Postgres Version (e.g. `14`)
40+
- Storage: (e.g. `hostpath`, `nfs`, or the name of your storage class)

‎.gitmodules‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[submodule "docs/themes/crunchy-hugo-theme"]
22
path = docs/themes/crunchy-hugo-theme
3-
url = https://github.com/CrunchyData/crunchy-hugo-theme
3+
url = https://github.com/crunchydata/crunchy-hugo-theme

‎README.md‎

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,68 @@
1-
# `pgo`, the Postgres Operator Client
1+
<h1 align="center">pgo: The CLI for the Postgres Operator from Crunchy Data</h1>
2+
<p align="center">
3+
<img width="150" src="./docs/static/logos/pgo.svg" alt="pgo: The CLI for the Postgres Operator from Crunchy Data"/>
4+
</p>
25

6+
# `pgo`, the Postgres Operator CLI from Crunchy Data
7+
8+
Welcome to the repository for the `pgo` Command Line Interface (CLI) for PGO,
9+
the Postgres Operator from Crunchy Data! Built as a `kubectl` plugin, the `pgo`
10+
CLI facilitates the creation and management of PostgreSQL clusters created using
11+
the Crunchy Postgres Operator. For more information about using the CLI and the
12+
various commands available, please see the PGO CLI
13+
[documentation](https://access.crunchydata.com/documentation/postgres-operator-client/latest).
14+
15+
## Install `pgo`, the Postgres Operator for Kubernetes Client
16+
17+
The following steps will allow you to download and install the `pgo`
18+
[kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)
19+
in your local environment.
20+
21+
### Prerequisites
22+
23+
Depending on your deployment type, Kubernetes or OpenShift, `kubectl` or `oc`
24+
must be installed and configured in your environment. For the purposes of these
25+
instructions we will be using the `kubectl` client. The `pgo`
26+
[kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)
27+
will use the role-based access controls (RBAC) that are configured for your
28+
`kubectl` client.
29+
30+
### Download the binary
31+
32+
The `kubectl-pgo` binary is available either through the Crunchy Data
33+
[Access Portal](https://access.crunchydata.com/downloads/) or via
34+
[GitHub](https://github.com/CrunchyData/postgres-operator-client/releases).
35+
36+
### Installing the Client
37+
38+
Once downloaded, move the `kubectl-pgo` binary to `/usr/local/bin` and make it
39+
executable by running the following commands:
40+
41+
```
42+
sudo mv /PATH/TO/kubectl-pgo /usr/local/bin/kubectl-pgo
43+
sudo chmod +x /usr/local/bin/kubectl-pgo
44+
```
45+
46+
### Checking the plugin install
47+
48+
Now that the `kubectl-pgo` binary is installed on your `PATH`, it can be used as
49+
a [kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/).
50+
Run the following command to ensure that the plugin is working:
51+
52+
```
53+
kubectl pgo version
54+
```
55+
56+
or if running in OpenShift:
57+
```
58+
oc pgo version
59+
```
60+
61+
## Compatibility
62+
63+
The `pgo` CLI supports all actively maintained versions of PGO v5+.
64+
65+
## More Information
66+
67+
For more about PGO, please see the
68+
[PGO Documentation](https://access.crunchydata.com/documentation/postgres-operator/).

‎docs/content/support/_index.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "Support"
3+
date:
4+
draft: false
5+
weight: 110
6+
---
7+
8+
There are a few options available for community support of the [`pgo` CLI for the Postgres Operator](https://github.com/CrunchyData/postgres-operator-client):
9+
10+
- **If you believe you have found a bug** or have a detailed feature request:
11+
please open
12+
[an issue on GitHub](https://github.com/CrunchyData/postgres-operator-client/issues/new/choose).
13+
The Postgres Operator community and the Crunchy Data team behind the PGO are
14+
generally active in responding to issues.
15+
16+
- **For general questions or community support**: please join the
17+
[PostgreSQL Operator community mailing list](https://groups.google.com/a/crunchydata.com/forum/#!forum/postgres-operator/join)
18+
at
19+
[https://groups.google.com/a/crunchydata.com/forum/#!forum/postgres-operator/join](https://groups.google.com/a/crunchydata.com/forum/#!forum/postgres-operator/join).
20+
21+
In all cases, please be sure to provide as many details as possible in regards to your issue, including:
22+
23+
- OS Version: (`RedHat 8.5`, `Ubuntu 20.04.4`, `macOS 11`, etc)
24+
- Platform: (`Kubernetes`, `OpenShift`, `Rancher`, `GKE`, `EKS`, `AKS`, etc)
25+
- Platform Version: (e.g. `1.22.1`, `4.9.1`)
26+
- `pgo` CLI Version: (e.g. `v0.1`)
27+
- PGO Operator Image Tag: (e.g. `ubi8-5.2.0-0`)
28+
- Postgres Version (e.g. `14`)
29+
- A detailed description of the issue, as well as steps you took that lead up to the issue
30+
- Any relevant logs
31+
- Any additional information you can provide that you believe we may find helpful
32+
33+
For production and commercial support of the PostgreSQL Operator, please
34+
[contact Crunchy Data](https://www.crunchydata.com/contact/) at
35+
[[email protected]](mailto:[email protected]) for information regarding an
36+
[Enterprise Support Subscription](https://www.crunchydata.com/about/value-of-subscription/).

0 commit comments

Comments
 (0)