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

     1  # Polaris helm
     2  
     3  English | [简体中文](./README-zh.md)
     4  
     5  This document describes how to install polaris service using helm chart.
     6  
     7  ## Prerequisites
     8  
     9  Make sure k8s cluster is installed and helm is installed.
    10  
    11  ## Install polaris helm chart
    12  
    13  ### Standalone
    14  
    15  You can modify `values.yaml` , set `global.mode` to `standalone` , then install using the command below,
    16  replacing `${release_name}` with your desired release name.
    17  
    18  ```shell
    19  $ cd deploy/helm
    20  $ helm install ${release_name} . 
    21  ```
    22  
    23  You can start directly with the following command:
    24  
    25  ```shell
    26  $ cd deploy/helm
    27  $ helm install ${release_name} . --set global.mode=standalone
    28  ```
    29  
    30  ### Cluster
    31  
    32  You need to modify `values.yaml`, set `global.mode` to `cluster`, and set the address information
    33  of `polaris.storage.db` and `polaris.storaate.redis`. Make sure your mysql has been initialized with the command below.
    34  
    35  ```shell
    36  mysql -u $db_user -p $db_pwd -h $db_host < store/sqldb/polaris_server.sql
    37  ```
    38  
    39  Once set up, install the chart with the following command.
    40  
    41  ```shell
    42  $ cd deploy/helm
    43  $ helm install ${release_name} . 
    44  ```
    45  
    46  ### Check the installation
    47  
    48  After deployment, the pod can be observed to run normally with the following command:
    49  
    50  ```shell
    51  $ kubectl get po -n polaris-system
    52  NAME                                  READY   STATUS    RESTARTS   AGE
    53  polaris-0                             2/2     Running   0          2m44s
    54  polaris-prometheus-6cd7cd5fc6-gqtcz   2/2     Running   0          2m44s
    55  ```
    56  
    57  If you configure `service.type` as `LoadBalancer` in `values.yaml`, you can use the `EXTERNAL-IP`:webPort of the polaris
    58  service to access the Polaris page. If your k8s cluster does not support `LoadBalancer` , you can set `service.type`
    59  to `NodePort` and access it through nodeip:nodeport . The page is as follows:
    60  ![img](./images/polaris.png)
    61  
    62  ## Uninstall polaris helm chart
    63  
    64  Uninstall your installed release with the command below, replacing `${release_name}` with the release name you used.
    65  
    66  ```shell
    67  $ helm uninstall `${release_name}`
    68  ```
    69  
    70  ## Configuration
    71  
    72  The currently supported configurations are as follows:
    73  
    74  | Parameter                            | Description                              |
    75  |--------------------------------------|--------------------------------------|
    76  |global.mode                           | Cluster type, supports `cluter` and `standalone` , indicating cluster version and stand-alone version|
    77  |polaris.image.repository              | polaris-server image repository address|
    78  |polaris.image.tag                     | polaris-server image tag|
    79  |polaris.image.pullPolicy              | polaris-server image pull policy|
    80  |polaris.limit.cpu                     | polaris-server cpu limit|
    81  |polaris.limit.memory                  | polaris-server memory limit|
    82  |polaris.console.image.repository      | polaris-console mage repository address|
    83  |polaris.console.image.tag             | polaris-console image tag|
    84  |polaris.console.image.pullPolicy      | polaris-console image pull policy|
    85  |polaris.console.limit.cpu             | polaris-console cpu limit|
    86  |polaris.console.limit.memory          | polaris-console memory limit|
    87  |polaris.replicaCount                  | polaris replicas|
    88  |polaris.storage.db.address            | polaris Cluster version, the address of mysql|
    89  |polaris.storage.db.name               | polaris Cluster version, the database name of mysql|
    90  |polaris.storage.db.user               | polaris Cluster version, the user of mysql|
    91  |polaris.storage.db.password           | polaris Cluster version, the password of mysql|
    92  |polaris.storage.redis.address         | polaris Cluster version, the address of redis|
    93  |polaris.storage.redis.password        | polaris Cluster version, the password of redis|
    94  |polaris.storage.service.type          | polaris service type|
    95  |polaris.storage.service.httpPort      | polaris service expose, polaris-server listening http port number|
    96  |polaris.storage.service.grpcPort      | polaris service expose, polaris-server listening grpc port number|
    97  |polaris.storage.service.webPort       | polaris service expose, polaris-server listening web  port number|
    98  |polaris.auth.consoleOpen              | polaris open the console interface auth, open the default|
    99  |polaris.auth.clientOpen               | polaris open the client interface auth, close the default|
   100  |monitor.port                          | The port through which the client reports monitoring information|
   101  |installation.namespace                | namespace for polaris installation|