Skip to content

Improve kubernetes documentation. #138

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

Closed
wants to merge 1 commit into from
Closed

Improve kubernetes documentation. #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions docs/toolhive/kubernetes/deploy-operator-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ Kubernetes cluster.

## Install the operator

:::note

You must first be authenticated to ghcr.io following
[these instructions](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).

:::

Comment on lines +22 to +28
Copy link
Collaborator

Choose a reason for hiding this comment

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

I just double-checked, this is not necessary - our images are public. I think it only bit you because you had previously logged in with a now-expired token?

Copy link
Author

Choose a reason for hiding this comment

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

I had to log into GHCR anyway, it was not working without this step. It might be an issue with my setup.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It must be, because I tried from a VM that has never logged into ghcr.io, also on my main laptop I did a docker logout ghcr.io just to be sure, and have not had an issue.

When did you see it, when trying to run helm to apply the chart? Any other image pulls would be happening from inside the cluster and not from your local Docker client.

Perhaps instead we make this a troubleshooting item at the bottom, in case people run into the scenario you did?

To install the ToolHive operator using Helm and the default settings, follow
these steps:

Expand Down
12 changes: 4 additions & 8 deletions docs/toolhive/kubernetes/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,9 @@ flowchart TB

## Installation

To install the ToolHive operator in your Kubernetes cluster, use Helm. Helm
simplifies the installation process and lets you manage the operator using Helm
charts.

[Deploy the operator using Helm](./deploy-operator-helm.md)
[Use Helm to install the ToolHive operator](./deploy-operator-helm.md) in your
Kubernetes cluster. Helm simplifies the installation process and lets you manage
the operator using Helm charts.

Once the operator is installed, you can create and manage MCP servers using the
`MCPServer` custom resource.

[Run MCP servers in Kubernetes](./run-mcp-k8s.md)
[`MCPServer` custom resource](./run-mcp-k8s.md).
Loading