Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix k8s guide to avoid suggesting you need cloud #14040

Merged
merged 4 commits into from
Jun 14, 2024
Merged

Fix k8s guide to avoid suggesting you need cloud #14040

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
beb29b7
you dont need cloud to use k8s with prefect
zzstoatzz Jun 14, 2024
92b4daf
indent
zzstoatzz Jun 14, 2024
bfeff84
fix values
zzstoatzz Jun 14, 2024
5a85677
Update docs/2.19.x/how-to-guides/work-pools/kubernetes.mdx
zzstoatzz Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/2.19.x/how-to-guides/work-pools/kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Prerequisites

Before we begin, there are a few pre-requisites:

1. A Prefect Cloud account
1. A Prefect Cloud account or a self-hosted Prefect server instance (see [self-hosting docs](https://docs.prefect.io/latest/guides/host/))
2. A cloud provider (AWS, GCP, or Azure) account
3. [Install](https://docs.prefect.io/getting-started/installation/) Python and Prefect
4. Install [Helm](https://helm.sh/docs/intro/install/)
Expand All @@ -20,7 +20,7 @@ Prefect is tested against Kubernetes 1.26.0 and newer minor versions.
<Note>
**Administrator Access**

Though not strictly necessary, you may want to ensure you have admin access, both in Prefect Cloud and in your cloud provider. Admin access is only necessary during the initial setup and can be downgraded after.
Though not strictly necessary, you may want to ensure you have admin access, both in Prefect Cloud (if applicable) and in your cloud provider. Admin access is only necessary during the initial setup and can be downgraded after.
</Note>

Create a cluster
Expand Down Expand Up @@ -326,6 +326,8 @@ kubectl create secret generic prefect-api-key \

Create a `values.yaml` file to customize the Prefect worker configuration. Add the following contents to the file:


#### Using Prefect Cloud
```
worker:
cloudApiConfig:
Expand All @@ -336,6 +338,16 @@ worker:

```

#### Using Prefect Server
```
worker:
serverApiConfig:
apiUrl: <dns or ip address of your Prefect Server instance>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this should be invented one

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated in indent


config:
workPool: <target work pool name>

```

These settings will ensure that the worker connects to the proper account, workspace, and work pool.

Expand Down Expand Up @@ -513,7 +525,7 @@ definitions:
```


Authenticate to Prefect
Authenticate to Prefect (if using Prefect Cloud)
---------------------------------------------------------------------

Before we deploy the flows to Prefect, we will need to authenticate via the Prefect CLI. We will also need to ensure that all of our flow's dependencies are present at `deploy` time.
Expand Down