diff --git a/docs/guide/loadbalancer-service.md b/docs/guide/loadbalancer-service.md index e4ce28783..4d8e3e726 100644 --- a/docs/guide/loadbalancer-service.md +++ b/docs/guide/loadbalancer-service.md @@ -28,7 +28,7 @@ containers: ### 创建 NetworkAttachmentDefinition CRD 资源 -参考以下 yaml,创建 `net-attach-def`资源:: +参考以下 yaml,创建 `net-attach-def` 资源: ```yaml apiVersion: "k8s.cni.cncf.io/v1" diff --git a/docs/reference/dev-env.en.md b/docs/reference/dev-env.en.md index f2f16fc37..8e2a59ee3 100644 --- a/docs/reference/dev-env.en.md +++ b/docs/reference/dev-env.en.md @@ -53,8 +53,13 @@ make base-arm64 ## Run E2E -Kube-OVN uses [KIND](https://kind.sigs.k8s.io/){: target="_blank" } to build local Kubernetes cluster, [j2cli](https://github.com/kolypto/j2cli){: target="_blank" } to render templates, -and [Ginkgo](https://onsi.github.io/ginkgo/){: target="_blank" } to run test cases. Please refer to the relevant documentation for dependency installation. +Kube-OVN uses: + +- [KIND](https://kind.sigs.k8s.io/) to build local Kubernetes cluster:` go install sigs.k8s.io/kind@latest ` +- [jinjanator](https://github.com/kpfleming/jinjanator) to render templates: ` pip install jinjanator ` +- [Ginkgo](https://onsi.github.io/ginkgo/) to run test cases:` go install github.com/onsi/ginkgo/v2/ginkgo; go get github.com/onsi/gomega/... ` + +> Please refer to the relevant documentation for dependency installation. Run E2E locally: diff --git a/docs/reference/dev-env.md b/docs/reference/dev-env.md index b2a185006..1da1abd55 100644 --- a/docs/reference/dev-env.md +++ b/docs/reference/dev-env.md @@ -52,8 +52,13 @@ make base-arm64 ## 运行 E2E -Kube-OVN 使用 [KIND](https://kind.sigs.k8s.io/){: target="_blank" } 构建本地 Kubernetes 集群,[j2cli](https://github.com/kolypto/j2cli){: target="_blank" } 渲染模板, -[Ginkgo](https://onsi.github.io/ginkgo/){: target="_blank" } 来运行测试代码。请参考相关文档进行依赖安装。 +Kube-OVN 使用: + +- [KIND](https://kind.sigs.k8s.io/) 来构建本地 Kubernetes 集群:` go install sigs.k8s.io/kind@latest ` +- [jinjanator](https://github.com/kpfleming/jinjanator) 来渲染模板: ` pip install jinjanator ` +- [Ginkgo](https://onsi.github.io/ginkgo/) 来运行测试代码:` go install github.com/onsi/ginkgo/v2/ginkgo; go get github.com/onsi/gomega/... ` + +> 详情请参考相关文档进行依赖安装。 本地执行 E2E 测试: diff --git a/docs/reference/releasing.en.md b/docs/reference/releasing.en.md index 5c0c61971..af79ebf83 100644 --- a/docs/reference/releasing.en.md +++ b/docs/reference/releasing.en.md @@ -41,4 +41,4 @@ Currently, the main tasks for Minor branches still need to be completed manually 1. Manually merge the GitHub action generated Release Note PR 8. Modify the GitHub Release information (manual) 1. Edit the newly created Release on the GitHub Release page, change the title to the corresponding version number (e.g., `v1.13.0`), and copy the Release Note generated in the previous step into the Release details -9. Update the `VERSION` file in the release branch to the next Patch version, e.g., `v1.13.1` \ No newline at end of file +9. Update the `VERSION` file in the release branch to the next Patch version, e.g., `v1.13.1` diff --git a/docs/reference/releasing.md b/docs/reference/releasing.md index f528ca9d8..f361cf2a2 100644 --- a/docs/reference/releasing.md +++ b/docs/reference/releasing.md @@ -41,4 +41,4 @@ Minor 版以主干分支是否有重大新功或重大的架构调整完成为 1. 手动 Merge github action 生成的 Release Note PR 8. 修改 Github Release 信息(手动) 1. 在 Github Release 页面编辑新生成的 Release,将标题修改为对应版本号(例如 `v1.13.0`),并复制上一步生成的 Release Note 到 Release 详情 -9. 修改发版分支的 `VERSION` 文件版本信息为下一个 Patch 版本,例如 `v1.13.1` \ No newline at end of file +9. 修改发版分支的 `VERSION` 文件版本信息为下一个 Patch 版本,例如 `v1.13.1` diff --git a/docs/reference/roadmap.md b/docs/reference/roadmap.md index 3a37da224..67b55e0e1 100644 --- a/docs/reference/roadmap.md +++ b/docs/reference/roadmap.md @@ -6,19 +6,19 @@ This document defines high level goals for Kube-OVN project. We welcome communit Kube-OVN currently supports two network modes, Overlay and Underlay. We hope to improve the stability, performance, and compatibility with the ecosystem of these two network modes in Kubernetes. -- Improved Datapath network performance -- Keeping up with the latest network API features in the community -- Enhanced network monitoring and visualization capabilities -- Addition of automated test cases for various scenarios +- Improved Datapath network performance +- Keeping up with the latest network API features in the community +- Enhanced network monitoring and visualization capabilities +- Addition of automated test cases for various scenarios ## VPC Network VPC network is a key feature of Kube-OVN, many functions have been used in production environment, and we hope to increase the maturity of these functions and improve the user experiences. -- Standardize multiple gateway solutions and provide the best egress practice -- Provide more VPC internal basic network capabilities and solutions, such as DNS, DHCP, LoadBalancer, etc. -- Simplify VPC operation complexity and provide a more comprehensive CLI -- Supplement automated test cases for various scenarios +- Standardize multiple gateway solutions and provide the best egress practice +- Provide more VPC internal basic network capabilities and solutions, such as DNS, DHCP, LoadBalancer, etc. +- Simplify VPC operation complexity and provide a more comprehensive CLI +- Supplement automated test cases for various scenarios ## User Experience diff --git a/overrides/contact.md b/overrides/contact.md index c3f2110f3..53d76fee8 100644 --- a/overrides/contact.md +++ b/overrides/contact.md @@ -2,4 +2,4 @@ [:material-slack: Slack](https://communityinviter.com/apps/kube-ovn/kube-ovn/){: target="_blank" .md-button } [:material-twitter: Twitter](https://twitter.com/KubeOvn){: target="_blank" .md-button } [:material-email: Support](https://jinshuju.net/f/fdJRKE){: target="_blank" .md-button } -[:simple-gotomeeting: Meeting](https://docs.google.com/document/d/1OPFC3s0rVxGkLR5GaUayNC6Nx9lwvjapg_hQl4MWt3E/edit#heading=h.1e73t98gdg9l){: target="_blank" .md-button } \ No newline at end of file +[:simple-gotomeeting: Meeting](https://docs.google.com/document/d/1OPFC3s0rVxGkLR5GaUayNC6Nx9lwvjapg_hQl4MWt3E/edit#heading=h.1e73t98gdg9l){: target="_blank" .md-button }