Skip to content

Commit f079745

Browse files
committed
Kubernetes: fix some typos and commas
1 parent 4712a79 commit f079745

File tree

2 files changed

+32
-28
lines changed

2 files changed

+32
-28
lines changed

docs/self-hosted/kubernetes-embedded.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ kubectl plugin by Replicated to run on a Kubernetes cluster. The plugin provides
66
Private Packagist Self-Hosted installation and allows you to monitor the application and perform maintenance operations
77
such as backups or updates.
88

9-
This will guide you through an installation without an existing cluster, to instead install Private Packagist Self-Hosted
9+
This page will guide you through an installation without an existing cluster. To instead install Private Packagist Self-Hosted
1010
in an existing Kubernetes cluster follow [this guide](./kubernetes-existing.md).
1111

1212
## General requirements
@@ -42,15 +42,15 @@ To learn more about options for the easy install script, please refer to the [Re
4242
curl -sSL https://kurl.sh/privatepackagistkots | sudo bash
4343
```
4444

45-
To log in to the admin console you will need the password shown at the end of the install command. You can also always
46-
regenerate the admin console password via `sudo kubectl kots reset-password default`.
45+
To log in to the admin console, you will need the password shown at the end of the install command. You can also always
46+
regenerate the admin console password via `sudo kubectl kots reset-password privatepackagistkots`.
4747

48-
After your Replicated Kubernetes is up and running you can follow the rest of the Packagist guide.
48+
After your Replicated Kubernetes cluster is up and running you can follow the rest of the Packagist guide.
4949

5050
### Replicated Configuration
5151
#### Replicated Setup
5252
Once Replicated’s services are installed on your server you need to access the management console on your browser.
53-
It’s available via SSL on port 8800. So open https://packagist.myintranet.com:8800/ in your browser (replace the domain with your own).
53+
It’s available via SSL on port 8800. Open https://packagist.myintranet.com:8800/ in your browser (replace the domain with your own).
5454
You will have to proceed despite the security warning (since your certificate is still missing).
5555

5656
![SSL Warning](/Resources/public/img/docs/self-hosted/console-tls-warning.png)
@@ -71,18 +71,18 @@ Login to the admin console using the password generated during the kots applicat
7171

7272
![Login to Admin Console](/Resources/public/img/docs/self-hosted-kubernetes/console-login.png)
7373

74-
On the next screen you can upload the supplied .yaml license key file. If you don't have the license key file yet then
74+
On the next screen, you can upload the supplied .yaml license key file. If you don't have the license key file yet then
7575
you can download it from https://packagist.com.
7676

7777
![Upload License](/Resources/public/img/docs/self-hosted-kubernetes/console-license.png)
7878

7979
#### Configure Private Packagist Self-Hosted
80-
The configuration screen is where you can setup the domains used for Private Packagist and the email configuration. It
80+
The configuration screen is where you can set up the domains used for Private Packagist and the email configuration. It
8181
is also the place where you can configure if Private Packagist should use an existing Redis, PostgreSQL, or blob storage.
8282
![Configuration](/Resources/public/img/docs/self-hosted-kubernetes/console-config.png)
8383

84-
Every configuration change or application update will trigger a preflight check. Once the preflight check passed, the changes
85-
can be applied to your Kubernetes cluster.
84+
Every configuration change or application update will trigger a preflight check. Once the preflight check have passed,
85+
the changes can be applied to your Kubernetes cluster.
8686
![Preflight Check](/Resources/public/img/docs/self-hosted-kubernetes/console-preflight.png)
8787

8888
The application overview in the admin console shows you the application status, your current license information, and any
@@ -93,8 +93,10 @@ via the domain configured for the web interface e.g. packagist.myintranet.com an
9393
### Setup authenticateion and Select Admin
9494

9595
#### Authentication Setup
96-
Within Private Packagist Self-Hosted you now need to set up at least one user authentication method. You have the choice between authentication with email addresses and passwords and several OAuth integrations with third party services.
97-
We provide integrations with on-premises versions of GitHub, Bitbucket, or GitLab, or their public services on github.com, bitbucket.org or gitlab.com. Follow the instructions to create the respective required identifiers, tokens and secrets.
96+
Within Private Packagist Self-Hosted, you now need to set up at least one user authentication method.
97+
You have the choice between authentication with email addresses and passwords and several OAuth integrations with third-party services.
98+
We provide integrations with on-premises versions of GitHub, Bitbucket, GitLab, or their public services on github.com, bitbucket.org,
99+
or gitlab.com. Follow the instructions to create the respective required identifiers, tokens, and secrets.
98100

99101
* [GitHub (Enterprise) Integration Setup](./github-integration-setup.md)
100102
* [Bitbucket.org Integration Setup](./bitbucket-integration-setup.md)
@@ -106,7 +108,7 @@ We provide integrations with on-premises versions of GitHub, Bitbucket, or GitLa
106108
![Add Integration](/Resources/public/img/docs/self-hosted/08-integration.png)
107109

108110
#### Selecting Admins
109-
After setting up an integration you can login through the top menu. Register an account and pick a username.
111+
After setting up an integration, you can log in through the top menu. Register an account and pick a username.
110112

111113
![Register Admin](/Resources/public/img/docs/self-hosted/09-register-admin.png)
112114

docs/self-hosted/kubernetes-existing.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
Private Packagist Self-Hosted leverages the [kots](https://docs.replicated.com/reference/kots-cli-getting-started)
55
kubectl plugin by Replicated to run on a Kubernetes cluster. The plugin provides a management interface to your
6-
Private Packagist Self-Hosted installation and allows you to monitor the application and perform maintenance operations
6+
Private Packagist Self-Hosted installation. It also allows you to monitor the application and perform maintenance operations
77
such as backups or updates.
88

9-
This will guide you through an installation with an existing cluster, to instead install Private Packagist Self-Hosted
9+
This page will guide you through an installation with an existing cluster, to instead install Private Packagist Self-Hosted
1010
without an existing Kubernetes cluster follow [this guide](./kubernetes-embedded.md).
1111

1212
## General requirements
@@ -31,7 +31,7 @@ Private Packagist requires the installation of the [kots](https://docs.replicate
3131
kubectl plugin from Replicated. The plugin provides an admin console to configure and update Private Packagist Self-Hosted.
3232

3333
The commands below will install the kots plugin and add the Private Packagist Self-Hosted application.
34-
At the end of the install script, kots will set up a port-forward to localhost:8800 where you can continue with the Private
34+
At the end of the install script, kots will set up a port forward to localhost:8800 where you can continue with the Private
3535
Packagist Self-Hosted setup. Once Private Packagist is fully configured and setup, it is recommended to stop the port
3636
forwarding and only start it again to make changes to the configuration or update the application.
3737

@@ -47,7 +47,7 @@ kubectl kots --help
4747
kubectl kots install privatepackagistkots
4848
```
4949

50-
To log in to the admin console you will need the password shown at the end of the install command. You can also always
50+
To log in to the admin console, you will need the password shown at the end of the install command. You can also always
5151
regenerate the admin console password via `sudo kubectl kots reset-password privatepackagistkots`.
5252

5353
### Replicated Configuration
@@ -57,30 +57,32 @@ Login to the admin console using the password generated during the kots applicat
5757

5858
![Login to Admin Console](/Resources/public/img/docs/self-hosted-kubernetes/console-login.png)
5959

60-
On the next screen you can upload the supplied .yaml license key file. If you don't have the license key file yet then
60+
On the next screen, you can upload the supplied .yaml license key file. If you don't have the license key file yet then
6161
you can download it from https://packagist.com.
6262

6363
![Upload License](/Resources/public/img/docs/self-hosted-kubernetes/console-license.png)
6464

6565
#### Configure Private Packagist Self-Hosted
66-
The configuration screen is where you can setup the domains used for Private Packagist and the email configuration. It
66+
The configuration screen is where you can set up the domains used for Private Packagist and the email configuration. It
6767
is also the place where you can configure if Private Packagist should use an existing Redis, PostgreSQL, or blob storage.
6868
![Configuration](/Resources/public/img/docs/self-hosted-kubernetes/console-config.png)
6969

70-
Every configuration change or application update will trigger a preflight check. Once the preflight check passed, the changes
71-
can be applied to your Kubernetes cluster.
70+
Every configuration change or application update will trigger a preflight check. Once the preflight check have passed,
71+
the changes can be applied to your Kubernetes cluster.
7272
![Preflight Check](/Resources/public/img/docs/self-hosted-kubernetes/console-preflight.png)
7373

7474
The application overview in the admin console shows you the application status, your current license information, and any
7575
available updates for Private Packagist. Once the application has entered the ready state, you can access Private Packagist
7676
via the domain configured for the web interface e.g. packagist.myintranet.com and finish the setup there.
7777
![Application Overview](/Resources/public/img/docs/self-hosted-kubernetes/console-application-overview.png)
7878

79-
### Setup authenticateion and Select Admin
79+
### Setup authentication and Select Admin
8080

8181
#### Authentication Setup
82-
Within Private Packagist Self-Hosted you now need to set up at least one user authentication method. You have the choice between authentication with email addresses and passwords and several OAuth integrations with third party services.
83-
We provide integrations with on-premises versions of GitHub, Bitbucket, or GitLab, or their public services on github.com, bitbucket.org or gitlab.com. Follow the instructions to create the respective required identifiers, tokens and secrets.
82+
Within Private Packagist Self-Hosted, you now need to set up at least one user authentication method.
83+
You have the choice between authentication with email addresses and passwords and several OAuth integrations with third-party services.
84+
We provide integrations with on-premises versions of GitHub, Bitbucket, GitLab, or their public services on github.com, bitbucket.org,
85+
or gitlab.com. Follow the instructions to create the respective required identifiers, tokens, and secrets.
8486

8587
* [GitHub (Enterprise) Integration Setup](./github-integration-setup.md)
8688
* [Bitbucket.org Integration Setup](./bitbucket-integration-setup.md)
@@ -92,7 +94,7 @@ We provide integrations with on-premises versions of GitHub, Bitbucket, or GitLa
9294
![Add Integration](/Resources/public/img/docs/self-hosted/08-integration.png)
9395

9496
#### Selecting Admins
95-
After setting up an integration you can login through the top menu. Register an account and pick a username.
97+
After setting up an integration, you can log in through the top menu. Register an account and pick a username.
9698

9799
![Register Admin](/Resources/public/img/docs/self-hosted/09-register-admin.png)
98100

@@ -110,9 +112,9 @@ That’s it! Private Packagist Self-Hosted is now ready to be used! You’ll fin
110112

111113
Private Packagist Self-Hosted will set up PostgreSQL, Redis, and MinIO to store application data and Composer packages.
112114
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.
113-
Configure the Storage Class under the Kubernetes Settings on Config page in the admin console
115+
Configure the Storage Class under the Kubernetes Settings on the Config page in the admin console.
114116

115-
Alternately, you can configure Private Packagist Self-Hosted to use your own PostgreSQL, Redis, and blob storage.
117+
Alternatively, you can configure Private Packagist Self-Hosted to use your own PostgreSQL, Redis, and blob storage.
116118
For blob storage, we currently support Azure Blob Storage, Google Cloud Storage, AWS S3, and other S3-compatible storage solutions.
117119

118120
## Security
@@ -125,8 +127,8 @@ Make sure your Kubernetes network plugin encrypts connections between pods to av
125127
## Backups
126128

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

131-
If you are using your own backup solution we recommend to make regular backups of PostgreSQL, Redis, and the used blob
133+
If you are using your own backup solution, we recommend making regular backups of PostgreSQL, Redis, and the used blob
132134
storage.

0 commit comments

Comments
 (0)