Skip to content

Commit 4460503

Browse files
authored
Adjust some md file name (#561)
* adjust some md file name * update bed url * rename of md file * rename some docs * prepare docs version 1.3.1 * update bad url * update bad url
1 parent cc6ab61 commit 4460503

File tree

391 files changed

+55118
-339
lines changed

Some content is hidden

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

391 files changed

+55118
-339
lines changed

blog/2022-02-21-linkis-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ normal as follows
420420
421421
422422
Check whether the material record of the engine exists (if there is an update, check whether the update time is correct).
423-
If it does not exist or is not updated, first try to manually refresh the material resource (for details, see [Engine Material Resource Refresh](docs/latest/deployment/engine-conn-plugin-installation#23-Engine Refresh)). Check the `log/linkis-cg-engineplugin.log` log to check the specific reasons for the failure of the material. In many cases, it may be caused by the lack of permissions in the hdfs directory. Check whether the gateway address configuration is correct `conf/linkis.properties:wds.linkis.gateway.url`
423+
If it does not exist or is not updated, first try to manually refresh the material resource (for details, see [Engine Material Resource Refresh](docs/latest/deployment/install-engineconn#23-Engine Refresh)). Check the `log/linkis-cg-engineplugin.log` log to check the specific reasons for the failure of the material. In many cases, it may be caused by the lack of permissions in the hdfs directory. Check whether the gateway address configuration is correct `conf/linkis.properties:wds.linkis.gateway.url`
424424
425425
The material resources of the engine are uploaded to the hdfs directory by default as `/apps-data/${deployUser}/bml`
426426
```shell script

blog/2022-04-15-how-to-download-engineconn-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ cd 1.0.3-engineconn-plugin
4747

4848
Copy the engine material package to be used to the engine plug-in directory of linkis, and then refresh the engine material.
4949

50-
For the detailed process, refer to [Installing the EngineConnPlugin Engine](https://linkis.apache.org/zh-CN/docs/latest/deployment/engine-conn-plugin-installation).
50+
For the detailed process, refer to [Installing the EngineConnPlugin Engine](https://linkis.apache.org/zh-CN/docs/latest/deployment/install-engineconn).

docs/deployment/cluster-deployment.md renamed to docs/deployment/deploy-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Cluster Deployment
3-
sidebar_position: 2
3+
sidebar_position: 1.1
44
---
55

66
Linkis's stand-alone deployment is simple, but it cannot be used in a production environment, because too many processes on the same server will make the server too stressful. The choice of deployment plan is related to the company's user scale, user habits, and the number of simultaneous users of the cluster. Generally speaking, we will choose the deployment method based on the number of simultaneous users using Linkis and the user's preference for the execution engine.

docs/deployment/web-install.md renamed to docs/deployment/deploy-console.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Console Deployment
3-
sidebar_position: 3
3+
sidebar_position: 1.2
44
---
55
```
66
The linkis web service uses nginx as a static resource server. The access request process is as follows :
77
Linkis Management Console request -> Nginx ip:port-> Linkis-gateway ip:port-> Other services
88
```
9-
Linkis 1.0 provides a Linkis Console, which provides functions such as displaying Linkis' global history, modifying user parameters, managing ECM and microservices, etc. Before deploying the front-end management console, you need to deploy the Linkis back-end. Linkis deployment manual See: [Linkis Deployment Manual](quick-deploy.md)
9+
Linkis 1.0 provides a Linkis Console, which provides functions such as displaying Linkis' global history, modifying user parameters, managing ECM and microservices, etc. Before deploying the front-end management console, you need to deploy the Linkis back-end. Linkis deployment manual See: [Linkis Deployment Manual](deploy-quick.md)
1010

1111
## 1. Preparation
1212

docs/deployment/quick-deploy.md renamed to docs/deployment/deploy-quick.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ hadoop ALL=(ALL) NOPASSWD: NOPASSWD: ALL
4444
4545
- Method 1: From the official website [download address](https://linkis.apache.org/zh-CN/download/main): https://linkis.apache.org/zh-CN/download/main
4646
, download the corresponding The installation package (project installation package and management console installation package)
47-
- Method 2: Compile the project installation package and management console according to [Linkis Compile and Package](../development/linkis-compile-and-package) and [Front-end Management Console Compile](../development/web-build) Installation package
47+
- Method 2: Compile the project installation package and management console according to [Linkis Compile and Package](../development/build) and [Front-end Management Console Compile](../development/build-console) Installation package
4848
4949
After uploading the installation package `apache-linkis-x.x.x-incubating-bin.tar.gz`, decompress the installation package
5050
@@ -412,13 +412,13 @@ If the verification fails, please refer to [Step 8] for troubleshooting
412412
## 6 Installation of development tool IDE (Scriptis) (optional)
413413
>After installing the Scripti tool, it can support writing SQL, Pyspark, HiveQL and other scripts online on the web page
414414
415-
For detailed instructions, see [Installation and Deployment of Tool Scriptis](./linkis-scriptis-install)
415+
For detailed instructions, see [Installation and Deployment of Tool Scriptis](./install-scriptis)
416416
417417
## 7. Supported Engines
418418
419419
### 7.1 Engine Adaptation List
420420
421-
Please note: The separate installation package of Linkis only contains four engines by default: Python/Shell/Hive/Spark. If there are other engines (such as jdbc/flink/sqoop and other engines) usage scenarios, you can install them manually. For details, please refer to [ EngineConnPlugin Engine Plugin Installation Documentation](engine-conn-plugin-installation).
421+
Please note: The separate installation package of Linkis only contains four engines by default: Python/Shell/Hive/Spark. If there are other engines (such as jdbc/flink/sqoop and other engines) usage scenarios, you can install them manually. For details, please refer to [ EngineConnPlugin Engine Plugin Installation Documentation](install-engineconn).
422422
423423
The list of supported engines that have been adapted in this version is as follows:
424424
@@ -526,7 +526,7 @@ The normal is as follows:
526526
527527
Check whether the material record of the engine exists (if there is an update, check whether the update time is correct).
528528
529-
- If it does not exist or is not updated, first try to manually refresh the material resource (for details, see [Engine Material Resource Refresh](engine-conn-plugin-installation#23-Engine Refresh)).
529+
- If it does not exist or is not updated, first try to manually refresh the material resource (for details, see [Engine Material Resource Refresh](install-engineconn#23-Engine Refresh)).
530530
- Check the specific reasons for material failure through `log/linkis-cg-engineplugin.log` log. In many cases, it may be caused by the lack of permissions in the hdfs directory
531531
- Check whether the gateway address configuration is correct. The configuration item `wds.linkis.gateway.url` of `conf/linkis.properties`
532532

docs/deployment/deploy-linkis-to-kbernetes.md renamed to docs/deployment/deploy-to-kubernetes.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
---
2-
title: linkis Container deployment
3-
sidebar_position: 12
2+
title: Kubernetes Deployment
3+
sidebar_position: 1.4
44
---
5+
56
This article describes how to deploy a Linkis service in a Kind Kubernetes environment for easier learning and debugging.
67

78
## 1. Dependencies and versions
9+
810
kind github:https://github.com/kubernetes-sigs/kind
911
kind web site:[kind.sigs.k8s.io/](https://kind.sigs.k8s.io/)
1012

11-
### versions:
12-
kind 0.14.0
13-
docker 20.10.17
14-
centos 7.6
15-
helm 3.x
13+
### Versions
14+
- kind 0.14.0
15+
- docker 20.10.17
16+
- centos 7.6
17+
- helm 3.x
1618

17-
### notice:
18-
1. Ensure that the component depends on the version
19-
2.kind means that the machine simulating node with docker container is restarted and the container has changed and the scheduler is not working anymore. This is a kind limitation and there is a detailed explanation in the official document.
19+
### Notice
20+
- 1. Ensure that the component depends on the version
21+
- 2. kind means that the machine simulating node with docker container is restarted and the container has changed and the scheduler is not working anymore. This is a kind limitation and there is a detailed explanation in the official document.
2022

2123
## 2.Install the docker
2224
### 2.1 Install the tutorial
@@ -41,60 +43,60 @@ vi /etc/docker/daemon.json
4143

4244
## 3. Install the kind
4345

44-
### (1)Manually download the kind binary
46+
### Step1 Manually download the kind binary
4547
```
4648
https://github.com/kubernetes-sigs/kind/releases
4749
```
48-
### (2)Install kind Binary
50+
### Step2 Install kind Binary
4951
```
5052
chmod +x ./kind
5153
mv kind-linux-amd64 /usr/bin/kind
5254
```
5355
## 4. Install linkis
54-
### 0.Download linkis1.3.0 deployment package
56+
### Step1 Download linkis1.3.0 deployment package
5557
```
5658
apache-linkis-1.3.0-incubating-bin.tar.gz
5759
```
58-
### 1.Build directory
60+
### Step2 Build directory
5961
```
6062
mkdir -p /opt/data/common/extendlib
6163
```
62-
### 2.Copy driver to /opt/data/common/extendlib
64+
### Step3 Copy driver to /opt/data/common/extendlib
6365
```
6466
curl https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar -o /opt/data/common/extendlib/[mysql-connector-java-8.0.28.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar)
6567
```
66-
### 3.Reset kind (not necessary)
68+
### Step3 Reset kind (not necessary)
6769
```
6870
./bin/install-linkis-to-kubernetes.sh reset
6971
```
70-
### 4.Pull the image
72+
### Step5 Pull the image
7173
```
7274
./bin/install-linkis-to-kubernetes.sh pull -mghcr.dockerproxy.com
7375
```
74-
### 5.Install linkis to kind
76+
### Step6 Install linkis to kind
7577
```
7678
./bin/install-linkis-to-kubernetes.sh install -l -mghcr.dockerproxy.com
7779
```
78-
### 6.Run commands to view services and wait until all services are successfully started
80+
### Step7 Run commands to view services and wait until all services are successfully started
7981
```
8082
kubectl get pods -A
8183
```
8284
![](/Images/deployment/kubernetes/pods.jpg)
8385

84-
### 7.Copy the ldh environment to linkis
86+
### Step8 Copy the ldh environment to linkis
8587
```
8688
./helm/scripts/prepare-for-spark.sh
8789
```
88-
### 8.Enabling Port Mapping
90+
### Step9 Enabling Port Mapping
8991
```
9092
./helm/scripts/remote-proxy.sh start
9193
```
92-
### 9.Access to the system
94+
### Step10 Access to the system
9395
```
9496
linkis-web: http://10.0.2.101:8088/
9597
eureka: http://10.0.2.101:20303/
9698
```
97-
### 10.Into the container
99+
### Step11 Into the container
98100
```
99101
./helm/scripts/login-pod.sh cg-engineconnmanager
100102
Executing shell tests

docs/deployment/deploy-linkis-without-hdfs.md renamed to docs/deployment/deploy-without-hdfs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy without HDFS
3-
sidebar_position: 8
3+
sidebar_position: 1.3
44
---
55

66
This article describes how to deploy Linkis services in an environment where HDFS is not deployed to facilitate more lightweight learning, use and debugging.

docs/deployment/installation-hierarchical-structure.md renamed to docs/deployment/directory-of-deployed.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: After Installation Directory Structure
3-
sidebar_position: 6.2
2+
title: After Installation Directory
3+
sidebar_position: 3.2
44
---
55

66
> The directory structure of Linkis 1.0 is very different from the 0.X version. Each microservice in 0.X has a root directory that exists independently. The main advantage of this directory structure is that it is easy to distinguish microservices and facilitate individual Microservices are managed, but there are some obvious problems:

docs/deployment/sourcecode-hierarchical-structure.md renamed to docs/deployment/directory-of-sourcecode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Source Code Directory Structure
3-
sidebar_position: 6
2+
title: Source Code Directory
3+
sidebar_position: 3.0
44
---
55

66
> Linkis source code hierarchical directory structure description, if you want to learn more about Linkis modules, please check [Linkis related architecture design](architecture/overview.md)

docs/deployment/unpack-hierarchical-structure.md renamed to docs/deployment/directory-of-unpack.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Installation Package Directory Structure
3-
sidebar_position: 6.1
2+
title: Installation Package Directory
3+
sidebar_position: 3.1
44
---
55

66
Download the officially released [Compilation Complete Package](https://linkis.apache.org/zh-CN/download/main), and the decompressed directory structure is as follows:

0 commit comments

Comments
 (0)