Skip to content

Commit

Permalink
feat:readme 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jinyalong committed Jun 9, 2023
1 parent e4442be commit 76fab36
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Introduction
The positioning of Operator is to serve as a perception and expansion of AlterShield in the cloud-native field of change, and our goal is to create a universal [Kubernetes Custom Resource (CRD)][CRD] control framework for change prevention.

AlterShield Operator is a Kubernetes Operator developed based on [Operator-SKD][Operator-SKD], aimed at improving the stability and reliability of Kubernetes clusters through control of Workload resources. This makes AlterShield not only suitable for traditional SOA architecture but also well-suited for cloud-native microservice system design.
AlterShield Operator is a Kubernetes Operator developed based on [Operator-SDK][Operator-SKD], aimed at improving the stability and reliability of Kubernetes clusters through control of Workload resources. This makes AlterShield not only suitable for traditional SOA architecture but also well-suited for cloud-native microservice system design.

You can also deploy Operator independently from the main [AlterShield][AlterShield] product, quickly deploying it to your Kubernetes cluster. Currently, Operator has achieved awareness of changes to Deployments, change prevention, change interception, change self-healing, and rollback.
More Workload controls and additional release methods are under development.
Expand All @@ -14,7 +14,7 @@ In robotics and automation, a control loop is a non-terminating loop that regula

The lifecycle is as follows:

![img.png](docs/img.png)
![img.png](docs/lifecycle.png)

The basic idea is to use the [WebHook][WebHook] capability of the Kubernetes API server to detect updates to CRDs. We typically define updates to WorkLoads as a type of change, with the minimum unit of change corresponding to the minimum scheduling unit of Kubernetes, which is the Pod. This design philosophy is consistent with the change information model defined by AlterShield. Through CRDs, we can declaratively describe and define changes, and the Operator internally implements the go language version of the AlterShield client, which accesses AlterShield according to the standard [change information model][ChangeModel].

Expand Down Expand Up @@ -76,7 +76,7 @@ Distributed under the Apache2.0 License. See `LICENSE` for more information.
[Change Pod]:https://github.com/traas-stack/altershield-operator/blob/main/apis/app.ops.cloud.alipay.com/v1alpha1/changepod_types.go
[ChangeModel]:https://traas-stack.github.io/altershield-docs/zh-CN/open-change-management-specification/change-model/
[Pod]:https://kubernetes.io/docs/concepts/workloads/pods/
[Operator-SKD]:https://sdk.operatorframework.io/
[Operator-SDK]:https://sdk.operatorframework.io/
[CRD]:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
[Deployment]:https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
[WebHook]:https://kubernetes.io/docs/reference/access-authn-authz/
Expand Down
6 changes: 3 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## 简介
Operator的定位是作为AlterShield在云原生领域变更的感知并扩充整个变更防控的服务领域,我们的目标是打造一个通用的[Kubernetes Custom Resource][CRD]防控框架。

AlterShield Operator是一款基于[Operator-SKD][Operator-SKD]开发的Kubernetes Operator,旨在通过对Workload资源的管控,提高Kubernetes集群的稳定性和可靠性。
AlterShield Operator是一款基于[Operator-SDK][Operator-SDK]开发的Kubernetes Operator,旨在通过对Workload资源的管控,提高Kubernetes集群的稳定性和可靠性。
这样AlterShield不仅适用于传统的SOA架构,同时也能很好的支持云原生化的微服务系统设计。

你也可以脱离[AlterShield][AlterShield]主端,独立的快速部署operator到你的Kubernetes集群中,当前已经实现对[Deployment][Deployment]变更的感知,
Expand All @@ -17,7 +17,7 @@ Workload 是 Kubernetes 中一种管理应用程序部署的抽象层。它可

生命周期如下:

![img.png](docs/img.png)
![img.png](docs/lifecycle.png)

基本思路是通过Kubernetes的Api Server的[WebHook][WebHook]能力感知CRD的更新,
对WorkLoad的更新操作我们通常定义成一种变更,而最小变更单元对应于Kubernetes最小调度单元Pod。这套设计理念和AlterShield定义的变更信息模型也是相呼应的。
Expand Down Expand Up @@ -54,7 +54,7 @@ AlterShield Operator当前具备的功能:
[Change Pod]:https://github.com/traas-stack/altershield-operator/blob/main/apis/app.ops.cloud.alipay.com/v1alpha1/changepod_types.go
[ChangeModel]:https://traas-stack.github.io/altershield-docs/zh-CN/open-change-management-specification/change-model/
[Pod]:https://kubernetes.io/docs/concepts/workloads/pods/
[Operator-SKD]:https://sdk.operatorframework.io/
[Operator-SDK]:https://sdk.operatorframework.io/
[CRD]:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
[Deployment]:https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
[WebHook]:https://kubernetes.io/docs/reference/access-authn-authz/
Expand Down
Binary file added docs/dingtalk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added docs/wechat.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 76fab36

Please sign in to comment.