Skip to content

Commit 072af2c

Browse files
committed
Helm: clarify several sections in the docs
1 parent 0ff5dbe commit 072af2c

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/self-hosted/kubernetes-helm.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ to instead install Private Packagist Self-Hosted without an existing Kubernetes
66

77
## General requirements
88

9-
1. A Kubernetes cluster v1.23 or v1.24
10-
1. Your username and password to log in to the registry. Don't have one yet? [Sign up for a free trial license!](https://packagist.com/self-hosted)
9+
1. A Kubernetes cluster v1.23 or newer
10+
1. Your username and password to log in to the Helm registry on registry.replicated.com. You can find your credentials with your Private Packagist account on https://packagist.com. Don't have one yet? [Sign up for a free trial license!](https://packagist.com/self-hosted)
1111
1. One (sub-)domain to operate the web interface, e.g. packagist.myintranet.com
1212
1. One (sub-)domain to operate the composer repository, e.g. repo.packagist.myintranet.com or packagist-repo.myintranet.com
1313
1. An SSL certificate valid for both chosen domains
@@ -23,7 +23,7 @@ to instead install Private Packagist Self-Hosted without an existing Kubernetes
2323
## Installation
2424

2525
Private Packagist Self-Hosted requires PostgreSQL, Redis, and blob storage to store application data and Composer packages.
26-
You can either use the build-in options to come with the Helm chart or use your own PostgreSQL, Redis, and blob storage.
26+
You can either use the built-in options that come with the Helm chart or use your own PostgreSQL, Redis, and blob storage.
2727
For blob storage, we currently support Azure Blob Storage, Google Cloud Storage, AWS S3, and other S3-compatible storage solutions.
2828

2929
Please note that if you chose to use the built-int solution then each of the storage requires one or more volumes using
@@ -32,16 +32,18 @@ Configure the Storage Class in global values section.
3232

3333
### Annotated configuration
3434

35+
To install the Private Packagist Self-Hosted Helm Chart configure values based on your setup, store them in a YAML file, e.g. values.yaml, and then run the commands below.
36+
3537
HELM_CHART_VALUES_FILE
3638

3739
#### Login to the Helm registry and install the chart
3840

39-
To install the Private Packagist Self-Hosted Helm Chart configure values based on your setup and then run the commands below.
40-
Make sure you replace `YOUR_USERNAME`, `YOUR_PASSWORD`, `YOURVALUES.yaml`, and `VERSION` with your values before running the commands.
41+
Make sure you replace `YOUR_USERNAME`, `YOUR_PASSWORD`, `values.yaml`, and `VERSION` with your values before running the commands.
42+
You can find the latest Private Packagist version on our [changelog page](/docs/self-hosted/changelog).
4143

4244
```
4345
helm registry login registry.replicated.com --username YOUR_USERNAME --password YOUR_PASSWORD
44-
helm install -f YOURVALUES.yaml private-packagist oci://registry.replicated.com/privatepackagistkots/unstable/private-packagist --version VERSION
46+
helm install -f values.yaml private-packagist oci://registry.replicated.com/privatepackagistkots/private-packagist --version VERSION
4547
```
4648

4749
#### Authentication Setup
@@ -78,10 +80,11 @@ That’s it! Private Packagist Self-Hosted is now ready to be used! You’ll fin
7880

7981
Private Packagist Self-Hosted will set up PostgreSQL, Redis, and MinIO to store application data and Composer packages.
8082
Each of them requires one or more volumes using [dynamic volume provision](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/) to allocate storage for the different Pods.
81-
Configure the Storage Class under the Kubernetes Settings on the Config page in the admin console.
83+
Configure the Storage Class in the values.yaml under `global.storageClass`.
8284

8385
Alternatively, you can configure Private Packagist Self-Hosted to use your own PostgreSQL, Redis, and blob storage.
8486
For blob storage, we currently support Azure Blob Storage, Google Cloud Storage, AWS S3, and other S3-compatible storage solutions.
87+
You can configure the blog storage in the values.yaml under `storage.type`.
8588

8689
## Security
8790

@@ -92,7 +95,7 @@ Make sure your Kubernetes network plugin encrypts connections between pods to av
9295

9396
## Backups
9497

95-
The Replicated admin console integrates with [Velero](https://velero.io/), a tool to back up and restore your Kubernetes
98+
The Private Packagist Self-Hosted application integrates with [Velero](https://velero.io/), a tool to back up and restore your Kubernetes
9699
cluster resources and persistent volumes. Private Packagist Self-Hosted provides annotations to help back up and restore
97100
the application with Velero.
98101

0 commit comments

Comments
 (0)