Common Operation

All sample applications are installed in namespace: apitable-app

To check the running status of the service, use the following command:

kubectl get pods -n apitable-app

2. To check the service logs, use the following commands:

kubectl  get pod -n apitable-app
kubectl  logs -f --tail=500 backend-server-pod-id -n apitable-app
kubectl  logs -f --tail=500 room-server-pod-id -n apitable-app

3. To restart a specific service, run the following command:

kubectl  rollout restart deployment/backend-server -n apitable-app

4. Modify environment variables in apitable-ee.yaml:

global:
  env:
    EDITION: "apitable-saas"
 
 app:
   web_server:
     env:
       KEY: VAL
   backend_server:
     env:
       KEY: VAL
   room_server:
     env:
       KEY: VAL
   socket_server:
     env:
       KEY: VAL

Execute helm upgrade command to make the configuration effective.

5. Customize nodes and resource limits for the service in apitable-ee.yaml:

 app:
   web_server:
     replicas: 2
     requests:
       cpu: 100m
       memory: 1024Mi
      ## Example:
      ## limits:
      ##    cpu: 250m
      ##    memory: 256Mi
     limits:
       cpu: 1000m
       memory: 2048Mi
   backend_server:
     replicas: 2
     requests:
       cpu: 100m
       memory: 1024Mi
     limits:
       cpu: 1000m
       memory: 2048Mi
   room_server:
      replicas: 2
     requests:
       cpu: 100m
       memory: 1024Mi
     limits:
       cpu: 1000m
       memory: 2048Mi
   socket_server:
     replicas: 2
     requests:
       cpu: 100m
       memory: 1024Mi
     limits:
       cpu: 1000m
       memory: 2048Mi

Execute helm upgrade command to make the configuration effective.

6. Update init-appdata version in apitable-ee.yaml

images:
  app:
    init_appdata: v1.13.0-alpha_build259
  repository:
    common: apitable/ee
    app:
      init_appdata: apitable/apitable-ee

Execute helm upgrade command to make the configuration effective.

7. Preview configuration changes (-- dry run)

helm upgrade --dry-run apitable-release -f apitable-ee.yaml oci://registry-1.docker.io/vikadata/vika-helm-chart -n apitable-app

8. Using external database and redis

The default installation is to use self-built mysql and redis. You can specify external components in apitable-ee.yaml

mysql configration ：

# It is recommended to set it to 2/3 of the total memory of the database server

innodb_buffer_pool_size = 4096M

innodb_log_buffer_size = 2048M

max_allowed_packet = 1024M

sql_mode = NO_ENGINE_SUBSTITUTION

sort_buffer_size = 2M

max_connections=1000

explicit_defaults_for_timestamp = ON

global:
  env:
    EDITION: "apitable-saas"
    MYSQL_DATABASE: "apitable"
    MYSQL_PASSWORD: "<your_mysql_password>"
    MYSQL_USERNAME: "<your_mysql_username>"
    MYSQL_HOST: "<your_mysql_host>"
    MYSQL_PORT: "3306"
    DATABASE_TABLE_PREFIX: "apitable_"
    REDIS_DB: "0"
    REDIS_HOST: "<your_redis_host>"
    REDIS_PASSWORD: "<your_redis_password>"

mysql:
  enabled: false
redis:
  enabled: false

Execute helm upgrade command to make the configuration effective.

9. Update license code in apitable-ee.yaml

license: "<replace-your-license>"

Execute helm upgrade command to make the configuration effective.