Skip to content

Add document of Admin #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xxx7xxxx wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add document of Admin #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion docs/user-manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@

# EaseMesh Manual

- [EaseMesh Manual](#easemesh-manual)
- [Introduction](#introduction)
- [Installation](#installation)
- [Client command tool](#client-command-tool)
- [Admin](#admin)
- [Mesh service](#mesh-service)
- [Tenant Spec](#tenant-spec)
- [MeshService Spec](#meshservice-spec)
Expand Down Expand Up @@ -52,6 +54,42 @@ Please check out [install.md](./install.md) to install the EaseMesh.

The client command tool of the EaseMesh is `emctl`, please checkout [emctl.md](./emctl.md) for usages.

## Admin

We implement the object `MeshController` running upon Easegress. The spec of MeshController could affect the general behavior of control plane. We could use `emctl apply` to update it, and its complete example and explanation would be:

```yaml
apiVersion: mesh.megaease.com/v2alpha1
kind: MeshController
metadata:
name: easemesh-controller
# HeartbeatInterval is the interval for one service instance reporting its heartbeat.
heartbeatInterval: 5s
# RegistryType indicates which protocol the registry center accepts.
registryType: consul
# APIPort is the port for worker's API server.
apiPort: 13009
# IngressPort is the port for http server in mesh ingress.
ingressPort: 19527
# External service registry name.
externalServiceRegistry:
# Clean old external registry data.
cleanExternalRegistry: true

security:
mtlsMode: permissive # Support permissive, strict
certProvider: selfSign # Only support selfSign
rootCertTTL: 48h
appCertTTL: 24h # Must be less than or equal to rootCertTTL

# Sidecar injection stuff, the values here are default ones
imageRegistryURL: docker.io
imagePullPolicy: IfNotPresent
sidecarImageName: megaease/easegress:server-sidecar
agentInitializerImageName: megaease/easeagent-initializer:latest
log4jConfigName: log4j2.xml
```

## Mesh service

Services are the first-class citizens of the EaseMesh. Developers need to breakdown their business logic into small units and implement it as services.
Expand Down Expand Up @@ -178,6 +216,8 @@ spec:

## MeshDeployment

> This Feature has been DELETED since v2.0.0.

> It will deprecated in version 1.4.0. We do not encourage to use it. Prefer to using with native deployment with dedicated annotation, refer to [Native deployment](#native-deployment).

EaseMesh relies on Kubernetes for managing service instances and the resources they require. For example, we can scale the number of instances with the help of Kubernetes. In fact, EaseMesh uses a mechanism called [Kubernetes Custom Resource Define(CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) to combine the service metadata used by EaseMesh and Kubernetes original deployment. MeshDeployment can be used not only to deploy and manage service instances, it can also help us implement the canary deployment.
Expand Down Expand Up @@ -761,4 +801,4 @@ spec:
name: group-metrics
matches:
- metrics
```
```