Skip to content

Commit 0ead5d8

Browse files
committed
Add sample configs docs
[noissue]
1 parent a58bf2c commit 0ead5d8

3 files changed

Lines changed: 72 additions & 5 deletions

File tree

staging_docs/admin/guides/configurations/reset_admin_pwd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Reset Pulp Admin Password
22

33
The password from Pulp admin user is managed by Pulp Operator. If a custom `Secret` is not provided
4-
during operator's installation, a [random password](/pulp_operator/configuring/secrets/#pulp-admin-password) will be provided.
4+
during operator's installation, a [random password](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/secrets/#pulp-admin-password) will be provided.
55

66
To change the admin password, the first thing to do is to get the name of the `admin_password_secret` `Secret`:
77
```sh
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Sample Configs
2+
3+
To help with the first steps of Pulp installation and [CR definition](https://pulpproject.org/pulp-operator/docs/admin/reference/custom_resources/repo_manager/#pulp), there are a set of [samples in pulp-operator repository](https://github.com/pulp/pulp-operator/tree/main/config/samples).
4+
5+
6+
7+
### MINIMAL CONFIGURATION
8+
9+
The [`minimal.yaml`](https://github.com/pulp/pulp-operator/blob/main/config/samples/minimal.yaml) file, provides a sample CR with
10+
the minimal configurations needed (the [database](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/database/) and [pulpcore storage](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/) definitions) for the operator to run. It will deploy Pulp with a single [replica of pulpcore](https://pulpproject.org/pulp-operator/docs/admin/guides/install/ha/#scaling-pulpcore-pods) pods and a [random password for the admin user](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/reset_admin_pwd/#reset-pulp-admin-password).
11+
12+
!!! note
13+
14+
The `minimal.yaml` sample will not deploy a reverse proxy or expose pulpcore pods.
15+
16+
17+
### SIMPLE
18+
19+
The [`simple.yaml`](https://github.com/pulp/pulp-operator/blob/main/config/samples/simple.yaml) file, provides a sample CR
20+
that will deploy Pulp with:
21+
22+
- a single [replica of pulpcore](https://pulpproject.org/pulp-operator/docs/admin/guides/install/ha/#scaling-pulpcore-pods) pods
23+
- a definition of the [StorageClass to store Pulp artifacts](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-pulp-operator-storage-to-use-a-storage-class)
24+
- a [database](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/database/) pod
25+
- a [cache](http://127.0.0.1:8000/pulp-operator/docs/admin/guides/configurations/cache/#configure-pulp-operator-to-deploy-a-redis-instance) pod
26+
- a [k8s Service type nodeport](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/networking/exposing/#nodeport)
27+
- a [pre-defined password for the admin user](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/secrets/#pulp-admin-password)
28+
- some [Pulp app configs](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/pulp_settings/#custom-settings) (settings.py definitions)
29+
30+
31+
### S3
32+
33+
The [`simple.s3.ci.yaml`](https://github.com/pulp/pulp-operator/blob/main/config/samples/simple.s3.ci.yaml) file, provides a sample CR
34+
that will deploy Pulp with:
35+
36+
- a single [replica of pulpcore](https://pulpproject.org/pulp-operator/docs/admin/guides/install/ha/#scaling-pulpcore-pods) pods
37+
- an [object storage (S3) to store Pulp artifacts](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-aws-s3-storage)
38+
- a [database](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/database/) pod
39+
- a [k8s Service type nodeport](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/networking/exposing/#nodeport)
40+
- a [pre-defined password for the admin user](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/secrets/#pulp-admin-password)
41+
- some [Pulp app configs](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/pulp_settings/#custom-settings) (settings.py definitions)
42+
43+
44+
### EXTERNAL DATABASE
45+
46+
The [`simple-external-db.yaml`](https://github.com/pulp/pulp-operator/blob/main/config/samples/simple-external-db.yaml) file, provides a sample CR
47+
that will deploy Pulp with:
48+
49+
- a single [replica of pulpcore](https://pulpproject.org/pulp-operator/docs/admin/guides/install/ha/#scaling-pulpcore-pods) pods
50+
- a definition of the [StorageClass to store Pulp artifacts](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-pulp-operator-storage-to-use-a-storage-class)
51+
- a definition of a [k8s Secret with the credentials to access a postgres database](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/database/#configure-pulp-operator-to-use-an-external-postgresql-installation) (not deployed/managed by pulp-operator)
52+
- a [k8s Service type nodeport](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/networking/exposing/#nodeport)
53+
- a [pre-defined password for the admin user](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/secrets/#pulp-admin-password)
54+
- some [Pulp app configs](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/pulp_settings/#custom-settings) (settings.py definitions)
55+
56+
57+
### INGRESS
58+
59+
60+
The [`simple.ingress.yaml`](https://github.com/pulp/pulp-operator/blob/main/config/samples/simple.ingress.yaml) file, provides a sample CR
61+
that will deploy Pulp with:
62+
63+
- a single [replica of pulpcore](https://pulpproject.org/pulp-operator/docs/admin/guides/install/ha/#scaling-pulpcore-pods) pods
64+
- a definition of the [StorageClass to store Pulp artifacts](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-pulp-operator-storage-to-use-a-storage-class)
65+
- a [database](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/database/) pod
66+
- some [Pulp app configs](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/pulp_settings/#custom-settings) (settings.py definitions)
67+
- a [k8s ingress](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/networking/exposing/#ingress)

staging_docs/admin/guides/configurations/storage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Before installing Pulp, it is necessary to configure how Pulp should persist the
44

55
[Pulp uses django-storages](https://docs.pulpproject.org/pulpcore/installation/storage.html) to support multiple types of storage backends. The current version of pulp-operator supports the following types of storage installation:
66

7-
* [Storage Class](#configuring-pulp-operator-storage-to-use-a-storage-class)
8-
* [Persistent Volume Claim](#configuring-pulp-operator-storage-to-use-a-persistent-volume-claim)
9-
* [Azure Blob](#configuring-pulp-operator-to-use-object-storage)
10-
* [Amazon Simple Storage Service (S3)](#configuring-pulp-operator-to-use-object-storage)
7+
* [Storage Class](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-pulp-operator-storage-to-use-a-storage-class)
8+
* [Persistent Volume Claim](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-pulp-operator-storage-to-use-a-persistent-volume-claim)
9+
* [Azure Blob](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-azure-blob-storage)
10+
* [Amazon Simple Storage Service (S3)](https://pulpproject.org/pulp-operator/docs/admin/guides/configurations/storage/#configure-aws-s3-storage)
1111

1212
!!! info
1313
Only one storage type should be provided, trying to configure Pulp CR with multiple storage types will fail operator execution.

0 commit comments

Comments
 (0)