Skip to content

Latest commit

 

History

History
483 lines (426 loc) · 22.4 KB

slime-boot.md

File metadata and controls

483 lines (426 loc) · 22.4 KB

SlimeBoot 介绍与使用

介绍

本文将介绍SlimeBoot的使用方式，并给出使用样例，指引用户安装并使用slime组件。slime-boot可以理解成一个Controller，它会一直监听SlimeBoot CR，当用户提交一份SlimeBoot CR后，slime-boot Controller会根据CR的内容渲染slime相关的部署材料。

准备

在安装slime组件前，需要安装SlimeBoot CRD和deployment/slime-boot

注意：在k8s v1.22以及之后的版本中，只支持apiextensions.k8s.io/v1版本的CRD，不再支持apiextensions.k8s.io/v1beta1版本CRD，详见k8s官方文档，而 k8s v1.16~v1.21 两个版本都能用

  1. 对于k8s v1.22以及之后版本，需要手动安装v1版本-crd，而之前版本可手动安装v1版本-crd或者v1beta1版本-crd
  2. 手动安装 deployment/slime-boot

或者执行以下命令安装slimeboot CRD和deployment/slime-boot，需要注意的是如果网络无法访问，你可以在项目的slime/install/init/目录发现相关文档

  • k8s version >= v1.22
export tag_or_commit=$(curl -s https://api.github.com/repos/slime-io/slime/tags | grep 'name' | cut -d\" -f4 | head -1)
kubectl create ns mesh-operator
kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/crds-v1.yaml"
kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/deployment_slime-boot.yaml"
  • k8s v1.16 <= version < 1.22 以下两者都能使用
export tag_or_commit=$(curl -s https://api.github.com/repos/slime-io/slime/tags | grep 'name' | cut -d\" -f4 | head -1)
kubectl create ns mesh-operator
kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/crds.yaml"
kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/deployment_slime-boot.yaml"
export tag_or_commit=$(curl -s https://api.github.com/repos/slime-io/slime/tags | grep 'name' | cut -d\" -f4 | head -1)
kubectl create ns mesh-operator
kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/crds-v1.yaml"
kubectl apply -f "https://raw.githubusercontent.com/slime-io/slime/$tag_or_commit/install/init/deployment_slime-boot.yaml"

参数介绍

根据之前的章节，我们知道用户通过下发SlimeBoot的方式，安装slime组件，在正常使用过程中，用户使用的SlimeBoot CR主要包含以下几项

  • image: 定义镜像相关的参数
  • resources： 定义容器资源
  • module: 定义需要启动的模块，以及对应的参数
    • name: 模块名称
    • kind：模块类别，目前只支持 lazyload/plugin/limiter/meshregistry
    • enable: 是否开启模块
    • global: 模块依赖的一些全局参数，一些详细信息可以参考 Config.global
    • general: 模块启动时需要的一些参数

样例如下：

apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: xxx ## real name
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-xxx ## real image
    tag: xxx  ## real image
  module:
    - name: xxx
      kind: xxx
      enable: true

安装

SlimeBoot支持两种安装方式

  • 模块部署：需要给每个子模块部署一份deployment

以下yaml是一个模块部署不完整样例，module中定义的第一个对象，就是该SlimeBoot应该具备的功能

apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: xxx ## real name
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-xxx ## real image
    tag: xxx  ## real image
  module:
    - name: xxx
      kind: xxx
      enable: true
  • bundle部署：只需部署一份deployment，该deployment包含多个组件功能

以下yaml是一个bundle模式不完整样例，其中module的第一个对象定义了这个服务拥有limiter和plugin功能，mudule中后两个对象分别对应limiter和plugin子模块的具体参数

apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: bundle
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-bundle-all
    tag: v0.8.2
  module:
    - name: bundle
      enable: true
      bundle:
        modules:
          - name: limiter
            kind: limiter
          - name: plugin
            kind: plugin        
    - name: limiter
      kind: limiter
      enable: true
      mode: BundleItem
      general: {}
      global: {}
    - name: plugin
      kind: plugin
      enable: true
      mode: BundleItem

下面将以模块方式安装lazyload，limiter和plugin模块以及用bundle模式安装bundle模块

lazyload安装样例

部署支持cluster级别的懒加载模块，成功后会在mesh-operator命名空间下部署名为lazyload和global-sidecar的deployment

  • istioNamespace：用户集群中，istio部署的ns
  • module: 指定lazyload部署的相关参数
    • name: 模块名称
    • kind：模块类别，目前只支持 lazyload/plugin/limiter/meshregistry
    • enable: 是否开启该模块
    • general: lazyload启动相关参数
    • global: lazyload依赖的一些全局参数，global具体参数可参考 Config.global
    • metric: lazyload服务间电泳关系依赖的指标信息
  • component：懒加载模块中关于globalSidecar的配置，除镜像外一般不用改动
apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: lazyload
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-lazyload
    tag: v0.8.2
  namespace: mesh-operator
  istioNamespace: istio-system
  module:
    - name: lazyload
      kind: lazyload
      enable: true
      general:
        autoPort: true
        autoFence: true
        defaultFence: true   
        wormholePort: # replace to your application service ports, and extend the list in case of multi ports
          - "9080"
        globalSidecarMode: cluster # the mode of global-sidecar
        metricSourceType: accesslog # indicate the metric source          
      global:
        log:
          logLevel: info
        slimeNamespace: mesh-operator
  resources:
    requests:
      cpu: 300m
      memory: 300Mi
    limits:
      cpu: 600m
      memory: 600Mi        
  component:
    globalSidecar:
      enable: true
      sidecarInject:
        enable: true # should be true
        mode: pod
        labels: # optional, used for sidecarInject.mode = pod
          sidecar.istio.io/inject: "true"
      resources:
        requests:
          cpu: 200m
          memory: 200Mi
        limits:
          cpu: 400m
          memory: 400Mi
      image:
        repository: docker.io/slimeio/slime-global-sidecar
        tag: v0.8.2
      probePort: 20000

limiter安装样例

安装支持单机限流功能的限流模块，成功后会在mesh-operator命名空间下部署名为limiter的deployment

  • image: 指定limiter的镜像，包括策略，仓库，tag
  • module: 指定limiter部署的相关参数
    • name: 模块名称
    • kind：模块类别，目前只支持 lazyload/plugin/limiter/meshregistry
    • enable: 是否开启该模块
    • general: limiter启动相关参数
      • disableGlobalRateLimit：禁用全局共享限流
      • disableAdaptive: 禁用自适应限流
      • disableInsertGlobalRateLimit: 禁止模块插入全局限流相关的插件
    • global: limiter依赖的一些全局参数，global具体参数可参考 Config.global
apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: limiter
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-limiter
    tag: v0.8.2
  module:
    - name: limiter
      kind: limiter
      enable: true
      general:
        disableGlobalRateLimit: true
        disableAdaptive: true
        disableInsertGlobalRateLimit: true

plugin 安装样例

安装plugin模块

  • image: 指定plugin的镜像，包括策略，仓库，tag
  • module: 指定plugin部署的相关参数
    • name: 模块名称
    • kind：模块类别，目前只支持 lazyload/plugin/limiter/meshregistry
    • enable: 是否开启该模块
    • global: plugin依赖的一些全局参数，global具体参数可参考 Config.global
apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: plugin
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-plugin
    tag: v0.8.2
  module:
    - name: plugin
      kind: plugin
      enable: true

meshregistry安装样例

安装对接多注册中心的meshregistry模块

  • image: 指定meshregistry的镜像，包括策略，仓库，tag
  • module: 指定meshregistry部署的相关参数
    • name: 模块名称
    • kind：模块类别，目前只支持 lazyload/plugin/limiter/meshregistry
    • enable: 是否开启该模块
    • general: meshregistry启动相关参数，支持配置K8SSource、EurekaSource、NacosSource、ZookeeperSource
    • global: meshregistry依赖的一些全局参数，global具体参数可参考 Config.global
apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: meshregistry
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-meshregistry
    tag: v0.8.2
  module:
  - name: meshregistry
    kind: meshregistry
    enable: true
    general:
      LEGACY:
        NacosSource:
          Enabled: true
          RefreshPeriod: 30s
          Address:
          - "http://nacos.test.com:8848"
          Mode: polling
        # EurekaSource:
        #   Enabled: true
        #   Address:
        #   - "http://test/eureka"
        #   RefreshPeriod: 15s
        #   SvcPort: 80
        # ZookeeperSource:
        #   Enabled: true
        #   RefreshPeriod: 30s
        #   WaitTime: 10s
        #   Address:
        #   - zookeeper.test.svc.cluster.local:2181

bundle模式安装样例

在上面的样例中，我们部署了lazyload，limiter和plugin模块，现在我们用bundle的模式安装包含上面三个功能的bundle模块

apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: bundle
  namespace: mesh-operator
spec:
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-bundle-all
    tag: v0.8.2
  module:
    - name: bundle
      enable: true
      bundle:
        modules:
          - name: bundle
            kind: lazyload
          - name: limiter
            kind: limiter
          - name: plugin
            kind: plugin
          - name: meshregistry
            kind: meshregistry
      global:
        log:
          logLevel: info
    - name: bundle #与上面的name一致TODO
      kind: lazyload
      enable: true
      mode: BundleItem
      general:
        autoPort: true
        autoFence: true
        defaultFence: true
        wormholePort: # replace to your application service ports, and extend the list in case of multi ports
        - "9080"
        globalSidecarMode: cluster # the mode of global-sidecar
        metricSourceType: accesslog # indicate the metric source        
      global:
        slimeNamespace: mesh-operator
    - name: limiter
      kind: limiter
      enable: true
      mode: BundleItem
      general:
        disableGlobalRateLimit: true
        disableAdaptive: true
        disableInsertGlobalRateLimit: true
    - name: plugin
      kind: plugin
      enable: true
      mode: BundleItem   
    - name: meshregistry
      kind: meshregistry
      enable: true
      mode: BundleItem
      general:
        LEGACY:
          MeshConfigFile: ""
          RevCrds: ""
          Mcp: {}
          K8SSource:
            Enabled: false   
  component:
    globalSidecar:
      replicas: 1
      enable: true
      sidecarInject:
        enable: true # should be true
        mode: pod
        labels: # optional, used for sidecarInject.mode = pod
          sidecar.istio.io/inject: "true"
      resources:
        requests:
          cpu: 200m
          memory: 200Mi
        limits:
          cpu: 400m
          memory: 400Mi
      image:
        repository: docker.io/slimeio/slime-global-sidecar
        tag: v0.8.2
      probePort: 20000 # health probe port
      port: 80 # global-sidecar default svc port
      legacyFilterName: true

多副本样例

以limiter为例，安装带有两个副本的limiter模块。

我们需要设置enableLeaderElection: "on"以及replicaCount: 2 可开启多副本模式。

apiVersion: config.netease.com/v1alpha1
kind: SlimeBoot
metadata:
  name: limiter
  namespace: mesh-operator
spec:
  replicaCount: 2   #多副本
  image:
    pullPolicy: Always
    repository: docker.io/slimeio/slime-limiter
    tag: v0.8.2
  module:
    - name: limiter
      kind: limiter
      enable: true
      general:
        disableGlobalRateLimit: true
        disableAdaptive: true
        disableInsertGlobalRateLimit: true
      global:
        misc:
          enableLeaderElection: "on"

Config.global

关于上面涉及到的 Config.global 内容如下：

Key Default Value Usages Remark
service app servicefence匹配服务的label key，用来生成懒加载中sidecar的默认配置
istioNamespace istio-system 部署istio组件的namespace，用来生成懒加载中sidecar的默认配置，应等于实际部署istio组件的namespace
slimeNamespace mesh-operator 部署slime模块的namespace，用来生成懒加载中sidecar的默认配置，应等于实际创建slimeboot cr资源的namespace
log.logLevel "" slime自身日志级别
log.klogLevel 0 klog日志级别
log.logRotate false 是否启用日志轮转，即日志输出本地文件
log.logRotateConfig.filePath "/tmp/log/slime.log" 本地日志文件路径
log.logRotateConfig.maxSizeMB 100 本地日志文件大小上限，单位MB
log.logRotateConfig.maxBackups 10 本地日志文件个数上限
log.logRotateConfig.maxAgeDay 10 本地日志文件保留时间，单位天
log.logRotateConfig.compress false 本地日志文件轮转后是否压缩
misc {"metrics-addr": ":8080", "aux-addr": ":8081"}, 可扩展的配置集合，目前支持一下参数参数：1."metrics-addr"定义slime module manager监控指标暴露地址；2."aux-addr"定义辅助服务器暴露地址
seLabelSelectorKeys app 默认应用标识，se 涉及
xdsSourceEnableIncPush true 是否进行xds增量推送
pathRedirect "" path从定向映射表