forked from kurator-dev/kurator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
- Loading branch information
1 parent
386cab0
commit 0ebbc35
Showing
2 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: "Developer Guide" | ||
linkTitle: "Developer Guide" | ||
weight: 6 | ||
description: > | ||
Provide guidance on details regarding development of Kurator. | ||
--- | ||
|
||
Here we will outline how to conduct development of Kurator and provide coding standards and guidelines. | ||
|
||
The developer guide for Kurator aims to standardize development practices and onboard new contributors efficiently. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: "Kurator E2E Test" | ||
linkTitle: "Kurator E2E Test" | ||
weight: 30 | ||
description: > | ||
Kurator End2End Test Guide | ||
--- | ||
|
||
Kurator has provided E2E Test in order to avoid potential impacts of future changes on the overall project, reduce future maintenance costs, and improve code and architecture quality. | ||
|
||
## Preparation For running E2E Test | ||
|
||
### Install Kind | ||
|
||
```console | ||
# For AMD64 / x86_64 | ||
[ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.20.0/kind-linux-amd64 | ||
# For ARM64 | ||
[ $(uname -m) = aarch64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.20.0/kind-linux-arm64 | ||
chmod +x ./kind | ||
sudo mv ./kind /usr/local/bin/kind | ||
``` | ||
|
||
### Install Helm | ||
|
||
- Manual installation | ||
|
||
```console | ||
1.Download the required version(https://github.com/helm/helm/releases) | ||
2.Extract a zip file(tar -zxvf helm-vXXX-linux-amd64.tar.gz) | ||
3.Find the helm program in the extracted directory and move it to the desired directory(mv linux-amd64/helm /usr/local/bin/helm) | ||
``` | ||
|
||
- Script Installation | ||
|
||
```console | ||
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | ||
chmod 700 get_helm.sh | ||
./get_helm.sh | ||
``` | ||
|
||
## Steps For Running E2E Test | ||
|
||
- Script to Install Kubernetes Test Cluster Environment. `bash hack/e2e-test/build-cluster.sh` | ||
- Deploying a Newest Built Kurator Image to the Cluster. `bash hack/e2e-test/install-kurator.sh` | ||
- Running Kurator E2E Tests. `bash hack/e2e-test/run-e2e.sh` |