Skip to content

Commit 286a8fc

Browse files
committed
docs: add docs
1 parent a7a3b3b commit 286a8fc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+3810
-86
lines changed

README.md

Lines changed: 1 addition & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -9,92 +9,7 @@
99

1010
## Getting Started
1111

12-
#### macOS
13-
14-
```
15-
brew install infrahq/tap/infra
16-
```
17-
18-
#### Windows
19-
20-
```powershell
21-
scoop bucket add infrahq https://github.com/infrahq/scoop.git
22-
scoop install infra
23-
```
24-
25-
#### Linux
26-
27-
Download the [latest](https://github.com/infrahq/infra/releases/latest) packages from GitHub and install it with `dpkg`, `apt`, `rpm`, or `dnf`.
28-
29-
```
30-
sudo dpkg -i infra_*.deb
31-
32-
sudo apt install ./infra_*.deb
33-
34-
sudo rpm -i infra-*.rpm
35-
36-
sudo dnf install infra-*.rpm
37-
```
38-
39-
### Create an access key
40-
41-
Log in to Infra. If you don't have a self-hosted Infra configured, you can sign up for a [free Infra instance](https://signup.infrahq.com) to get started.
42-
43-
Set the INFRA_SERVER variable to your Infra URL:
44-
45-
```
46-
export INFRA_SERVER=<org>.infrahq.com
47-
```
48-
49-
```
50-
infra login
51-
```
52-
53-
You'll be prompted for the Infra URL you created when you signed up. (e.g. `<org>.infrahq.com`).
54-
55-
Then, create an access key:
56-
57-
```
58-
INFRA_ACCESS_KEY=$(infra keys add --connector -q)
59-
```
60-
61-
### Connect Kubernetes cluster
62-
63-
Install Infra connector via [helm](https://helm.sh):
64-
65-
```
66-
helm repo add infrahq https://infrahq.github.io/helm-charts
67-
helm repo update
68-
helm install infra infrahq/infra --set config.server.url=$INFRA_SERVER --set config.accessKey=$INFRA_ACCESS_KEY --set config.name=example
69-
```
70-
71-
### Access your cluster
72-
73-
Give yourself permission to access the cluster:
74-
75-
```
76-
infra grants add <your user email> example --role view
77-
```
78-
79-
Use `infra list` to verify access.
80-
81-
Run `kubectl` to switch to your newly connected cluster.
82-
83-
```
84-
kubectl config use-context infra:example
85-
```
86-
87-
Alternatively, you can switch clusters via `infra use` command.
88-
89-
```
90-
infra use example
91-
```
92-
93-
Lastly, try running a command on the Kubernetes cluster:
94-
95-
```
96-
kubectl get pods -A
97-
```
12+
See the [quickstart guide](./docs/quickstart.md)
9813

9914
## Next steps
10015

0 commit comments

Comments
 (0)