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.

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

docs(brew): Updated docs to reference loft homebrew tap #1580

Merged
merged 1 commit into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/pages/deploying-vclusters/high-availability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ You also need your kube config pointing to that cluster (you can connect and run
If you’re on a Mac and using Homebrew, you can install the vCluster CLI with this command:

```
brew install vcluster
brew install loft-sh/tap/vcluster
```

For other platforms, see [the installation instructions](../getting-started/setup.mdx).

# 2. Understanding vCluster distros
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/fragments/install/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import TabItem from "@theme/TabItem";
brew install loft-sh/tap/vcluster
```

If you installed the CLI using `brew install vcluster`, you should `brew uninstall vcluster` and then install using the tap.
If you installed the CLI using `brew install loft-sh/tap/vcluster`, you should `brew uninstall vcluster` and then install using the tap.
The binaries in the tap are signed using the [Sigstore](https://docs.sigstore.dev/) framework for enhanced security.

</TabItem>
Expand Down
7 changes: 4 additions & 3 deletions docs/pages/help&tutorials/bootstrapping.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ The only prerequisite is a Kubernetes cluster that you can run the virtual clust
If you use a Mac with Homebrew, you can install the CLI with this command:

```
brew install vcluster
brew install loft-sh/tap/vcluster
```

For other platforms, see [the installation docs](../getting-started/setup.mdx). The CLI is supported on macOS, Linux, and Windows.

# Apply a manifest on initialization
Expand Down Expand Up @@ -49,7 +50,7 @@ init:
- name: nginx
image: nginx:1.25.1
ports:
- containerPort: 80
- containerPort: 80
```

Let’s break down what’s happening here.
Expand Down Expand Up @@ -163,4 +164,4 @@ First, if you are connected to the virtual cluster, disconnect with the vcluster
```
kubectl logs -n vcluster-NAME -l app=vcluster,release=NAME -c syncer
```
Substitute the name you gave your virtual cluster in the vcluster connect command for NAME in both places. By default, vcluster prepends the string vcluster- to the name of the virtual cluster’s namespace.
Substitute the name you gave your virtual cluster in the vcluster connect command for NAME in both places. By default, vcluster prepends the string vcluster- to the name of the virtual cluster’s namespace.
2 changes: 1 addition & 1 deletion docs/pages/help&tutorials/helm-provisioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For this tutorial, you will need:

- A Kubernetes cluster to use as the host cluster and a kube context that points at it. vCluster works both with local and remote Kubernetes clusters.
- The Helm Command Line Interface (CLI). You can find installation instructions [here](https://helm.sh/docs/intro/install/?_gl=1*158hplf*_ga*MjEzODEwMTQ1My4xNjY3MjA5OTgx*_ga_4RQQZ3WGE9*MTY5NjMyMTgwMy4xMzcuMS4xNjk2MzI0MDAzLjE2LjAuMA..*_gcl_au*MTYzMDM2NDc5NC4xNjkwMzczNjIyLjIwMTE4NTM2MTIuMTY5NTA0NjA0Ny4xNjk1MDQ2MDQ2/).
- The vCluster CLI. If you use a Mac with Homebrew, you can install it with this command: brew install vcluster. For other platforms, see [the installation docs](../getting-started/setup.mdx).
- The vCluster CLI. If you use a Mac with Homebrew, you can install it with this command: `brew install loft-sh/tap/vcluster`. For other platforms, see [the installation docs](../getting-started/setup.mdx).
# 1. Provision a vCluster with Helm
If you have previously used the vCluster CLI to create a virtual cluster, you may have noticed that the vcluster create command uses Helm. Here’s some example output:

Expand Down