Skip to content

Commit e64cf2a

Browse files
committed
Add Usage section to README
1 parent 93e7de0 commit e64cf2a

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,26 @@ It enables management of ClickHouse clusters (running inside your Kubernetes clu
66
wherever they may be) through Altinity.Cloud.
77

88
At present, this repository is used only to distribute pre-built `altinitycloud-connect` binaries.
9-
The source code is scheduled to be released once we're out of Beta.
9+
The source code is planned to be released once we're out of Beta.
10+
11+
## Usage
12+
13+
### CLI
14+
15+
Download pre-built binary from [GitHub Releases](https://github.com/altinity/altinitycloud-connect/releases) page.
16+
Sign in to the [Altinity.Cloud Management Console](https://acm.altinity.cloud/), grab environment connect token & then
17+
exchange it for a certificate:
18+
19+
```shell script
20+
altinitycloud-connect login --token=REPLACE_WITH_ALTINITY_CLOUD_CONNECT_TOKEN
21+
```
22+
23+
Kubernetes cluster can now be connected with
24+
25+
```shell script
26+
altinitycloud-connect kubernetes | kubectl apply -f -
27+
```
28+
29+
### Terraform
30+
31+
See [altinity/terraform-altinitycloud-connect](https://github.com/altinity/terraform-altinitycloud-connect).

0 commit comments

Comments
 (0)