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

Jump to bottom

[Docs] Update helm deployment docs #4865

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Docs] Update helm deployment docs #4865

wants to merge 1 commit into from

Conversation

romilbhardwaj
Copy link
Collaborator

  • Moves helm repo update to step 3
  • Removes full helm installation commands from credential setup steps to avoid users copy pasting and running helm install before setting up other features (e.g., ingress authentication)

Michaelvll
Michaelvll approved these changes Mar 2, 2025
View reviewed changes
Copy link
Collaborator

@Michaelvll Michaelvll left a comment

Choose a reason for hiding this comment

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

Thanks for the update @romilbhardwaj! LGTM

docs/source/reference/api-server/api-server-admin-deploy.rst
$ helm upgrade --install skypilot skypilot/skypilot-nightly --devel \
$ --namespace $NAMESPACE \
$ --create-namespace \
$ # helm upgrade --install ... \
$ --set ingress.authSecret=my-existing-auth-secret

Copy link
Collaborator

Choose a reason for hiding this comment

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

minor: I prefer to be able to directly copy paste the entire command needed to setup. I am wondering if we can have an Examples subsection in step 3, which list out some common combination for the cloud setups (these commands can be folded with <details> or tables, to make it take less spaces.

docs/source/reference/api-server/api-server-admin-deploy.rst
$ helm upgrade --install skypilot skypilot/skypilot-nightly --devel \
$ --namespace $NAMESPACE \
$ --create-namespace \
$ # helm upgrade --install ... \
$ --set ingress.authSecret=my-existing-auth-secret

The secret must be in the same namespace as the API server and must contain a key named ``auth`` with the basic auth credentials in htpasswd format.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we add a cross reference to Step 3 in the section Updating the API server?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Michaelvll Michaelvll Michaelvll approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@romilbhardwaj @Michaelvll