Skip to content

Commit 9226569

Browse files
ruyingzheQianChenglong
authored andcommitted
feat: Add installation guides (#62)
1 parent 656a0da commit 9226569

File tree

12 files changed

+95
-0
lines changed

12 files changed

+95
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@
3838

3939
We are preparing how to use TKE-related documentation. At the same time, the release package is also generated by our configuration of the github codebase-based pipeline. Once these are ready, we will update the documentation here.
4040

41+
## Installation
42+
43+
TKEStack use tke-installer tool to deploy, please follow the guide to get TKEStack up and running.
44+
45+
* [TKEStack Install](docs/devel/install.md)
46+
4147
## To start developing TKE
4248

4349
Make sure that you have [Git-LFS](https://github.com/git-lfs/git-lfs) installed before developing TKE.

docs/devel/install.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Install TKEStack
2+
3+
The easiest way to get started with TKEStack is via tke-installer.
4+
5+
The tke-installer tool contains all resources required by the installation, provide a Web GUI to guide customer installing TKEStack.
6+
7+
## Architecture
8+
9+
![Architecture Of TKE](../images/[email protected])
10+
11+
* Installer - the tke-installer tool is on this node, provide a Web GUI to guide customer installing global cluster
12+
* Global - a k8s cluster which is used to deploy TKEStack console and components
13+
* Cluster - customer cluster, it can be created or imported through TKEStack console
14+
15+
## Prerequisites
16+
17+
The hardware requirements for nodes mostly depend on your workloads, the minimum to run the global cluster node is:
18+
19+
* Hardware
20+
* 8 vCPU
21+
* 16 GB of Memory
22+
23+
> Note: Installer node need extra 20GB disk to store images and temporary files.
24+
25+
TKEStack is tested on the following operating system:
26+
27+
* Operating Systems
28+
* Ubuntu 16.04 (64-bit)
29+
* CentOS Linux 7.5 (64-bit)
30+
31+
32+
## Installing tke-installer
33+
34+
First Log in to your Linux host and install tke-installer via this command:
35+
36+
version=v1.0.0 && wget https://tke-release-1251707795.cos.ap-guangzhou.myqcloud.com/tke-installer-x86_64-$version.run{,.sha256} && sha256sum --check --status tke-installer-x86_64-$version.run.sha256 && chmod +x tke-installer-x86_64-$version.run && ./tke-installer-x86_64-$version.run
37+
38+
> Note: this command can be found at [TKEStack Release](https://github.com/tkestack/tke/releases)
39+
>
40+
> Note: tke-installer is about 3GB, contains all resources required by the installation, TKEStack will be installed offline, behind a firewall or behind a proxy.
41+
42+
43+
## Starting the installation
44+
45+
Open your browser to http://`INSTALLER-NODE-IP`:8080/index.html, the Web GUI will guide you to initialize and install the TKEStack.
46+
47+
1. Set the account information and HA VIP
48+
49+
![Architecture Of TKE](../images/install/Picture2.png)
50+
51+
2. Configure the global cluster, set cluster's nic, GPU type and container network, specify the master node information,advance option enable you to set customized parameters
52+
53+
![Architecture Of TKE](../images/install/Picture3.png)
54+
55+
3. Set authentication information
56+
57+
![Architecture Of TKE](../images/install/Picture4.png)
58+
59+
4. Specify the image registry, TKEStack will deploy a local registry by default
60+
61+
![Architecture Of TKE](../images/install/Picture5.png)
62+
63+
5. Business setting,default is on
64+
65+
![Architecture Of TKE](../images/install/Picture6.png)
66+
67+
6. Monitor settings,TKE will install an influxDB as the monitor data's storage, or specify the influxDB address and ES address, or disable the monitor
68+
69+
![Architecture Of TKE](../images/install/Picture7.png)
70+
71+
7. Console settings, if enabled, specify the console page's address and certificate
72+
73+
![Architecture Of TKE](../images/install/Picture8.png)
74+
75+
8. Preview all the configuration, if no problem, click `install` to start, next page will show the install logs in real time
76+
77+
![Architecture Of TKE](../images/install/Picture9.png)
78+
79+
80+
## Using TKEStack
81+
82+
After the installation is completed, you will receive a `===>install task [Success]` message, click the `Guidance` button to check the TKEStack console address, open a browser to access.
83+
84+
![Architecture Of TKE](../images/install/Picture10.png)
85+
86+
The login username and password are specified in previous installation step:
87+
88+
* ***Username***: admin
89+
* ***Password***: secret

docs/images/[email protected]

44.4 KB
Loading

docs/images/install/Picture10.png

159 KB
Loading

docs/images/install/Picture2.png

52.5 KB
Loading

docs/images/install/Picture3.png

91.1 KB
Loading

docs/images/install/Picture4.png

42 KB
Loading

docs/images/install/Picture5.png

47.9 KB
Loading

docs/images/install/Picture6.png

43.4 KB
Loading

docs/images/install/Picture7.png

46.1 KB
Loading

0 commit comments

Comments
 (0)