github.com/polarismesh/polaris@v1.17.8/release/cluster/helm/README-zh.md (about)

     1  # Polaris helm
     2  
     3  简体中文 | [English](./README.md)
     4  
     5  本文档介绍如何使用 helm chart 安装 polaris 服务。
     6  
     7  ## 准备工作
     8  
     9  确保已经安装 k8s 集群，且安装了 helm。
    10  
    11  ## 安装 polaris helm chart
    12  
    13  ### 安装单机版
    14  
    15  您可以修改 `values.yaml` ，将 `global.mode` 设置为 `standalone` ，然后使用下面的命令安装，将 `${release_name}` 替换为您需要的 release 名。
    16  
    17  ```shell
    18  $ cd deploy/helm
    19  $ helm install ${release_name} . 
    20  ```
    21  
    22  您可以可以直接使用下面的命令启动：
    23  
    24  ```shell
    25  $ cd deploy/helm
    26  $ helm install ${release_name} . --set global.mode=standalone
    27  ```
    28  
    29  ### 安装集群版
    30  
    31  您需要修改 `values.yaml` ，将 `global.mode` 设置为 `cluster` ，同时设置 `polaris.storage.db` 和 `polaris.storaate.redis` 的地址信息。 确保您的
    32  mysql 已经使用下面的命令初始化了。
    33  
    34  ```shell
    35  mysql -u $db_user -p $db_pwd -h $db_host < store/sqldb/polaris_server.sql
    36  ```
    37  
    38  设置好后，使用下面的命令安装 chart：
    39  
    40  ```shell
    41  $ cd deploy/helm
    42  $ helm install ${release_name} . 
    43  ```
    44  
    45  ### 检查安装
    46  
    47  部署后可以通过以下命令观察到 pod 正常运行：
    48  
    49  ```shell
    50  $ kubectl get po -n polaris-system
    51  NAME                                  READY   STATUS    RESTARTS   AGE
    52  polaris-0                             2/2     Running   0          2m44s
    53  polaris-prometheus-6cd7cd5fc6-gqtcz   2/2     Running   0          2m44s
    54  ```
    55  
    56  如果您在 `values.yaml` 中配置了 `service.type` 为 `LoadBalancer` 则可以使用 polaris 的 service 的 `EXTERNAL-IP`:webPort 访问到北极星的页面。 如果您的
    57  k8s 集群不支持  `LoadBalancer` ，可以将 `service.type` 为 `NodePort` ，通过 nodeip:nodeport 访问。页面如下图：
    58  
    59  ![img](./images/polaris.png)
    60  
    61  ## 卸载 polaris helm chart
    62  
    63  使用下面命令卸载您安装的 release ，将 `${release_name}` 替换为您使用的 release 名。
    64  
    65  ```shell
    66  $ helm uninstall `${release_name}`
    67  ```
    68  
    69  ## 配置
    70  
    71  当前支持的配置如下：
    72  
    73  | 参数名                                | 参数解释                              |
    74  |--------------------------------------|--------------------------------------|
    75  |global.mode                           | 集群类型，支持 `cluter` 和 `standalone` ，表示集群版和单机版|
    76  |polaris.image.repository              | polaris-server 镜像仓库地址|
    77  |polaris.image.tag                     | polaris-server 镜像 tag|
    78  |polaris.image.pullPolicy              | polaris-server 镜像拉取策略|
    79  |polaris.limit.cpu                     | polaris-server cpu资源占用限制|
    80  |polaris.limit.memory                  | polaris-server 内存资源占用限制|
    81  |polaris.console.image.repository      | polaris-console 的镜像仓库地址|
    82  |polaris.console.image.tag             | polaris-console 镜像 tag|
    83  |polaris.console.image.pullPolicy      | polaris-console 镜像拉取策略|
    84  |polaris.console.limit.cpu             | polaris-console cpu资源占用限制|
    85  |polaris.console.limit.memory          | polaris-console 内存资源占用限制|
    86  |polaris.replicaCount                  | polaris 副本数|
    87  |polaris.storage.db.address            | polaris 集群版，使用的 mysql 的地址|
    88  |polaris.storage.db.name               | polaris 集群版，使用的 mysql 的 database 名|
    89  |polaris.storage.db.user               | polaris 集群版，使用的 mysql 的用户名|
    90  |polaris.storage.db.password           | polaris 集群版，使用的 mysql 的密码|
    91  |polaris.storage.redis.address         | polaris 集群版，使用的 redis 的地址|
    92  |polaris.storage.redis.password        | polaris 集群版，使用的 redis 的密码|
    93  |polaris.storage.service.type          | polaris service 的类型|
    94  |polaris.storage.service.httpPort      | polaris service 暴露，polaris-server 监听的 http 端口|
    95  |polaris.storage.service.grpcPort      | polaris service 暴露，polaris-server 监听的 grpc 端口|
    96  |polaris.storage.service.webPort       | polaris service 暴露，polaris-server 监听的 web 端口|
    97  |polaris.auth.consoleOpen              | polaris 打开控制台接口鉴权，默认开启|
    98  |polaris.auth.clientOpen               | polaris 打开客户端接口鉴权，默认关闭|
    99  |monitor.port                          | 客户端上报监控信息的端口|
   100  |installation.namespace                | 部署polaris组件所在的namespace|
   101  
   102  
   103  
   104  
   105  
   106  
   107  
   108  
   109  
   110  
   111  
   112  
   113  
   114  
   115  
   116  
   117