Skip to content

Commit d7d0768

Browse files
committed
update readme accordingly
1 parent 13a2619 commit d7d0768

File tree

4 files changed

+118
-63
lines changed

4 files changed

+118
-63
lines changed

aio.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## All in one (aio) scripts, thanks the contribution from Papaya
2+
3+
感谢来自木瓜移动小伙伴的贡献。这个部分会让整个部署过程的控制脚本和配置都集中在2个核心文件,极大的简化了整个流程,也让第一次使用的小伙伴更容易上手。
4+
5+
### 配置文件
6+
7+
`cp conf/example-configure.ini conf/configure.ini`
8+
9+
根据项目需求修改配置文件 `conf/configure.ini`
10+
11+
### 部署
12+
13+
```sh
14+
./bin/deploy.sh -h 查看帮助
15+
16+
```
17+
#### 创建gke集群
18+
19+
`./bin/deploy.sh -m gke -a create`
20+
21+
#### 生成k8s配置
22+
23+
`./bin/deploy.sh -m temp -a debug`
24+
#### 部署es
25+
26+
`./bin/deploy.sh -m es -a deploy`
27+
28+
#### 部署kibana
29+
30+
`./bin/deploy.sh -m kbn -a deploy`
31+
32+
#### 部署lb
33+
34+
*申请lb静态IP*
35+
36+
`./bin/deploy.sh -m glb -a reserve`
37+
38+
*配置dns*
39+
40+
`./bin/deploy.sh -m glb -a dns`
41+
42+
*申请ssl证书*
43+
44+
`./bin/deploy.sh -m glb -a cert`
45+
46+
*部署lb*
47+
48+
`./bin/deploy.sh -m glb -a deploy`

bin/demo.sh

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,18 @@ __status() {
122122
passwd=$(__password)
123123
lb_ip=`kubectl get services ${es_cluster_name}-es-http -o jsonpath='{.status.loadBalancer.ingress[0].ip}'`
124124

125-
#curl -u "elastic:$passwd" -k "https://$lb_ip:9200"
126-
127125
kbn_ip=`kubectl get service dingo-demo-kbn-kb-http -o jsonpath='{.status.loadBalancer.ingress[0].ip}'`
128126
kbn_port=5601
129127
kbn_url=https://${kbn_ip}:${kbn_port}
130128

131-
echo; echo "================================="
132-
echo "Access Kibana at: " ${kbn_url}
129+
echo; echo "================================="; echo
130+
echo "Elasticsearch status: "
131+
curl -u "elastic:$passwd" -k "https://$lb_ip:9200"
132+
133+
echo; echo "---------------------------------"; echo
134+
135+
echo "Kibana: " ${kbn_url}
136+
echo "Elasticsearch: " "https://$lb_ip:9200"
133137
echo "Username: " elastic
134138
echo "Password: " ${passwd}
135139
echo "================================="; echo

readme.md

Lines changed: 58 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,54 @@ Now we are good to go!
1818

1919
---
2020

21-
## Quickstart 快速开始
21+
## Quickstart 快速开始(一键启动,用于测试、演示、PoC)
22+
23+
By default, the GKE resources will be launched in `asia-east1`, a.k.a [Taiwan](https://github.com/elasticsearch-cn/elastic-on-gke/blob/develop/bin/demo.sh#L7), region as a zonal cluster in zone-a to minimize your demo/PoC costs. Feel free to change & [choose one](https://cloud.google.com/compute/docs/regions-zones) close to you.
24+
25+
After that you are all set.
26+
27+
`./bin/demo.sh` will setup everything for you. Once completed, you should seen something similar to the following output
28+
29+
```
30+
=================================
31+
32+
Elasticsearch status:
33+
{
34+
"name" : "dingo-demo-es-zone-a-1",
35+
"cluster_name" : "dingo-demo",
36+
"cluster_uuid" : "9y_DYwNCRWezAEbKp3ko3g",
37+
"version" : {
38+
"number" : "8.2.1",
39+
"build_flavor" : "default",
40+
"build_type" : "docker",
41+
"build_hash" : "db223507a0bd08f8e84a93e329764cc39b0043b9",
42+
"build_date" : "2022-05-19T16:34:08.043347449Z",
43+
"build_snapshot" : false,
44+
"lucene_version" : "9.1.0",
45+
"minimum_wire_compatibility_version" : "7.17.0",
46+
"minimum_index_compatibility_version" : "7.0.0"
47+
},
48+
"tagline" : "You Know, for Search"
49+
}
50+
51+
---------------------------------
52+
53+
Kibana: https://34.83.123.100:5601
54+
Elasticsearch: https://34.91.123.200:9200
55+
Username: elastic
56+
Password: cI805x9s21Rg83cm46hRlUhV
57+
=================================
58+
```
59+
60+
and you could always retrieve above information by running `./bin/demo.sh status`
61+
62+
### clean up
63+
64+
To tidy things up and release all the created cloud resources, simply run `./bin/demo.sh clean`
65+
66+
---
67+
68+
## Get Started 详细文档
2269

2370
Check the [Advanced topics](https://github.com/elasticsearch-cn/elastic-on-gke#advanced-topics) if you would like to:
2471

@@ -27,7 +74,14 @@ Check the [Advanced topics](https://github.com/elasticsearch-cn/elastic-on-gke#a
2774
- k8s/GKE & Elasticsearch node sizing
2875
- Use your own meaningful names for workloads/services/ingress etc.
2976

30-
### Preparations
77+
Alternatives to start the deployment
78+
79+
- [All-in-one scripts](https://github.com/elasticsearch-cn/elastic-on-gke/blob/develop/aio.md)
80+
- [terraform](https://github.com/elasticsearch-cn/elastic-on-gke/tree/develop/terraform)
81+
82+
OK, let's get down to the business.
83+
84+
### Preparations 准备工作
3185

3286
#### Setup your `project_id` & targeting region to deploy
3387

@@ -42,7 +96,7 @@ For targeting region, you will need to update two files
4296

4397
Change the `region` variable on your choice, `asia-east1` by default.
4498

45-
#### Choose a predefined Elasticsearch deployment
99+
#### Choose a predefined Elasticsearch deployment 选择一个预置的集群架构
46100

47101
You can later adjust all these settings to archieve your own goal. We will discuss more in [Advanced topics](https://github.com/elasticsearch-cn/elastic-on-gke#advanced-topics).
48102

@@ -84,58 +138,7 @@ By now, in your *working directory*, you should be able to run `cat ./conf/gcs.c
84138

85139
---
86140

87-
## All in one (aio) scripts, thanks the contribution from Papaya
88-
89-
感谢来自木瓜移动小伙伴的贡献。这个部分会让整个部署过程的控制脚本和配置都集中在2个核心文件,极大的简化了整个流程,也让第一次使用的小伙伴更容易上手。
90-
91-
### 配置文件
92-
93-
`cp conf/example-configure.ini conf/configure.ini`
94-
95-
根据项目需求修改配置文件 `conf/configure.ini`
96-
97-
### 部署
98-
99-
```sh
100-
./bin/deploy.sh -h 查看帮助
101-
102-
```
103-
#### 创建gke集群
104-
105-
`./bin/deploy.sh -m gke -a create`
106-
107-
#### 生成k8s配置
108-
109-
`./bin/deploy.sh -m temp -a debug`
110-
#### 部署es
111-
112-
`./bin/deploy.sh -m es -a deploy`
113-
114-
#### 部署kibana
115-
116-
`./bin/deploy.sh -m kbn -a deploy`
117-
118-
#### 部署lb
119-
120-
*申请lb静态IP*
121-
122-
`./bin/deploy.sh -m glb -a reserve`
123-
124-
*配置dns*
125-
126-
`./bin/deploy.sh -m glb -a dns`
127-
128-
*申请ssl证书*
129-
130-
`./bin/deploy.sh -m glb -a cert`
131-
132-
*部署lb*
133-
134-
`./bin/deploy.sh -m glb -a deploy`
135-
136-
---
137-
138-
### Launch GKE/k8s cluster
141+
### Launch GKE/k8s cluster 部署 GKE/k8s 资源池
139142

140143
Run `./bin/gke.sh create`
141144

templates/es.demo.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ metadata:
44
name: dingo-demo
55
spec:
66
version: 8.2.1
7-
#http:
8-
#service:
9-
#spec:
10-
#type: LoadBalancer
7+
http:
8+
service:
9+
spec:
10+
type: LoadBalancer
1111
secureSettings:
1212
- secretName: gcs-credentials
1313
nodeSets:

0 commit comments

Comments
 (0)