Skip to content

Commit ec07c81

Browse files
Update misspelling in kubernetes.md (#1357)
* Update misspelling in kubernetes.md OAuth2 was misspelled in two places in this documentation * Name and package capitalization and formatting --------- Co-authored-by: Debbie Matthews <[email protected]>
1 parent 0fe07a6 commit ec07c81

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

content/deploy/tutorials/kubernetes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Deploy Streamlit using Kubernetes
33
slug: /deploy/tutorials/kubernetes
44
description: Learn how to deploy your Streamlit app using Kubernetes with Google Container Registry, OAuth authentication, and TLS support.
5-
keywords: kubernetes, k8s, deployment, gcr, google container registry, oauth, authentication, tls, load balancer, orchestration
5+
keywords: kubernetes, k8s, deployment, gcr, google container registry, OAuth, authentication, tls, load balancer, orchestration
66
---
77

88
# Deploy Streamlit using Kubernetes
@@ -131,24 +131,24 @@ If you are using Streamlit version 1.10.0 or higher, you must set the `WORKDIR`
131131
Put the above files (`run.sh` and `Dockerfile`) in the same folder and build the docker image:
132132

133133
```docker
134-
docker build --platform linux/amd64 -t gcr.io/$GCP_PROJECT_ID/k8s-streamlit:test .
134+
docker build --platform linux/amd64 -t gcr.io/<GCP_PROJECT_ID>/k8s-streamlit:test .
135135
```
136136

137137
<Important>
138138

139-
Replace `$GCP_PROJECT_ID` in the above command with the name of your Google Cloud project.
139+
Replace `<GCP_PROJECT_ID>` in the above command with the name of your Google Cloud project.
140140

141141
</Important>
142142

143143
### Upload the Docker image to a container registry
144144

145145
The next step is to upload the Docker image to a container registry. In this example, we will use the [Google Container Registry (GCR)](https://cloud.google.com/container-registry). Start by enabling the Container Registry API. Sign in to Google Cloud and navigate to your project’s **Container Registry** and click **Enable**.
146146

147-
We can now build the Docker image from the previous step and push it to our project’s GCR. Be sure to replace `$GCP_PROJECT_ID` in the docker push command with the name of your project:
147+
We can now build the Docker image from the previous step and push it to our project’s GCR. Be sure to replace `<GCP_PROJECT_ID>` in the docker push command with the name of your project:
148148

149149
```bash
150150
gcloud auth configure-docker
151-
docker push gcr.io/$GCP_PROJECT_ID/k8s-streamlit:test
151+
docker push gcr.io/<GCP_PROJECT_ID>/k8s-streamlit:test
152152
```
153153

154154
## Create a Kubernetes deployment
@@ -165,11 +165,11 @@ As the image was uploaded to the container registry in the previous step, we can
165165

166166
Make sure your [Kubernetes client](https://kubernetes.io/docs/tasks/tools/#kubectl), `kubectl`, is installed and running on your machine.
167167

168-
### Configure a Google OAuth Client and oauth2-proxy
168+
### Configure a Google OAuth Client and OAuth2-Proxy
169169

170-
For configuring the Google OAuth Client, please see [Google Auth Provider](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider#google-auth-provider). Configure oauth2-proxy to use the desired [OAuth Provider Configuration](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider) and update the oath2-proxy config in the config map.
170+
For configuring the Google OAuth Client, please see [Google Auth Provider](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider#google-auth-provider). Configure OAuth2-Proxy to use the desired [OAuth Provider Configuration](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider) and update the OAuth2-Proxy config in the config map.
171171

172-
The below configuration contains a ouath2-proxy sidecar container which handles the authentication with Google. You can learn more from the [oauth2-proxy repository](https://github.com/oauth2-proxy/oauth2-proxy).
172+
The below configuration contains an OAuth2-Proxy sidecar container which handles the authentication with Google. You can learn more from the [`oauth2-proxy` repository](https://github.com/oauth2-proxy/oauth2-proxy).
173173

174174
### Create a Kubernetes configuration file
175175

@@ -227,7 +227,7 @@ spec:
227227
- mountPath: "/etc/oauth2-proxy"
228228
name: oauth2-config
229229
- name: streamlit
230-
image: gcr.io/GCP_PROJECT_ID/k8s-streamlit:test
230+
image: gcr.io/<GCP_PROJECT_ID>/k8s-streamlit:test
231231
imagePullPolicy: Always
232232
ports:
233233
- containerPort: 8501
@@ -273,7 +273,7 @@ spec:
273273
274274
<Important>
275275
276-
While the above configurations can be copied verbatim, you will have to configure the `oauth2-proxy` yourself and use the correct `GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_ID`, `GCP_PROJECT_ID`, and `REDIRECT_URL`.
276+
While the above configurations can be copied verbatim, you will have to update the following placeholders: `<GOOGLE_CLIENT_ID>`, `<GOOGLE_CLIENT_SECRET>`, `<REDIRECT_URL>`, and `<GCP_PROJECT_ID>`.
277277

278278
</Important>
279279

0 commit comments

Comments
 (0)