Skip to content

Commit 4a4001c

Browse files
author
paul
committed
fix readme
1 parent 50360b0 commit 4a4001c

File tree

1 file changed

+4
-72
lines changed

1 file changed

+4
-72
lines changed

README.md

Lines changed: 4 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,11 @@ Desktop client for [Containerum.com](https://containerum.com) platform.
44
To use it sign up on [Containerum.com](https://containerum.com).
55

66
## Documentation
7-
[See full ENG documentation](https://github.com/containerum/chkit/wiki)
8-
## Installation
97

10-
**1.** Download binaries for MacOs, Ubuntu x32, Ubuntu x64, Windows x32 and Windows x64 [here](https://github.com/containerum/chkit/releases).
11-
12-
**2.** Extract the file to any directory.
13-
14-
for **Ubuntu** and **MacOs**:
15-
```
16-
$ tar -xvf your_archive.tar -C /path/to/destination/dir/
17-
```
18-
Run the client from `/path/to/destination/dir/`:
19-
```
20-
$ ./chkit
21-
```
22-
**Note**
23-
See how to run the client on Ubuntu/MacOs from any directory and use `chkit`, not `./chkit` command [here](https://containerum.com/documentation/Installing-Containerum-CLI-from-binaries).
24-
25-
## Usage
26-
27-
**1.** Sign Up at [containerum.com](https://containerum.com).
28-
29-
**2.** Open Terminal and run `chkit login`
30-
31-
```
32-
$ chkit login
33-
Enter your email: [email protected]
34-
Password:
35-
********
36-
Chosen namespace: mynamespace
37-
Successful login
38-
Token changed to: QA0u64rOkTtCxxxxxxxxxxliUAnBnPlCbGQfpCQpzqM=
39-
```
40-
Your Terminal should look like this finally:
41-
42-
![](images/all.png)
43-
44-
Follow the next steps bellow.
45-
46-
**3.** Let's deploy any app from the [DockerHub](https://hub.docker.com), let it be [Hello, World! It's Containerum](https://hub.docker.com/r/containerum/helloworld/).
47-
48-
**4.** Use `chkit run` command:
49-
```
50-
$ chkit run hello --configure
51-
52-
Enter image: containerum/helloworld
53-
Enter ports:
54-
Enter labels (key=value ... key3=value3):
55-
Enter commands (command1 ... command3):
56-
Enter environ variables (key=value ... key3=value3):
57-
Enter CPU cores count(*m):100m
58-
Enter memory size(*Mi | *Gi): 128Mi
59-
Enter replicas count: 1
60-
run... OK
61-
```
62-
**5.** Use `chkit expose` command:
63-
```
64-
$ chkit expose deploy hello -p hellosvc:5000:TCP
65-
66-
expose... OK
67-
```
68-
**5.** Use `chkit get` command:
69-
```
70-
$ chkit get svc
71-
72-
+------------+--------------+---------+-------------------+----------------+-----+
73-
| NAME | CLUSTER-IP | EXTERNAL| HOST | PORT(S) | AGE |
74-
+------------+--------------+---------+-------------------+----------------+-----+
75-
| hello-926c | 10.103.95.119| true | containerum.io | 20865:5000/TCP | 15s |
76-
+------------+--------------+---------+-------------------+----------------+-----+
8+
Buid with env
9+
```fish
10+
set -x CONTAINERUM_API "https://api.containerum.io:8082"
11+
make release
7712
```
78-
**6.** Go to http://x1.containerum.io:20865:
7913

80-
![](images/result.png)
8114

82-
Done!

0 commit comments

Comments
 (0)