klaytn/finder-helm-chart

finder-helm-chart

Klaytn Finder Helm Charts

This repository is for the helm charts of the Klaytn Finder Backend. For the overall architecture of the finder, please refer to the Main Repo.

The code is provided as-is with no warranties.

Usage

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add the repo as follows:

helm repo add klaytn-finder https://klaytn.github.io/finder-helm-chart/

create namepsace finder

kubectl create namespace finder

parameter	value
global.nameOverride	override defulat name finder
global.network	baobab or cypress
global.profile	stag, prod
global.namespace	create service aacount with the namespace
global.serviceAccountRoleArn	service account role arn created
secretManager.REGION	aws secret manager regsion
secretManager.ARN	aws secret manager ARN arn:aws:secretsmanager:${region}:${identity-number}:secret:${secret name}
s3.AWS_S3_REGION	AWS S3 region
s3.AWS_S3_PRIVATE_BUCKET	AWS S3 private bucket name
s3.AWS_S3_PUBLIC_BUCKET	AWS S3 public bucket name
cdn.URL	CDN service URL
chain.CAVER_CYPRESS_RPC_ENDPOINT	Klaytn Cypress RPC endpoint
chain.CAVER_BAOBAB_RPC_ENDPOINT	Klaytn Baobab RPC endpoint
datbaseEndpoint	Database End Point
openSearch.OPEN_SEARCH_URL	elastic open search url
redis.REDIS_ENDPOINT	redis endpoint
apiEndpint	this endpoint should match host of api

SPRING_PROFILES_ACTIVE

Each service has an environment parameter SPRING_PROFILES_ACTIVE. Changing this parameter changes the services that are run, so please refer to the table below and fill it out.

serivce	profile	network	value
api	prod	baobab	prodBaobab,api
api	prod	cypress	prodCypress,api
api	stage	baobab	stagBaobab,all,devAuthToken
api	stage	cypress	stagCypress,all,devAuthToken
oapi	prod	baobab	prodBaobab
oapi	prod	cypress	prodCypress
oapi	stage	baobab	stagBaobab
oapi	stage	cypress	stagCypress
papi	prod	baobab	prodBaobab,papi
papi	prod	cypress	prodCypress,papi
worker			prod
compiler			prod

Exmaple for Values.yaml

create my-values.yaml file

global:
  nameOverride: finder
  network: baobab
  profile: prod
  namespace: finder
  serviceAccountName: sa-finder-service
  serviceAccountRoleArn: arn:aws:iam:************:role/klaytn_cluster_prod-finder-****

secretManager:
  REGION: ap-northeast-2
  ARN: arn:aws:secretsmanager:ap-northeast-2:************:secret:****

s3:
  AWS_S3_REGION: ap-northeast-2
  AWS_S3_PRIVATE_BUCKET: klaytn-prod-finder-private
  AWS_S3_PUBLIC_BUCKET: klaytn-prod-common-public

cdn:
  URL: https://cdn.********.io

chain:
  CAVER_CYPRESS_RPC_ENDPOINT: https://public-en.klaytnfinder.io/v1/cypress
  CAVER_BAOBAB_RPC_ENDPOINT: https://public-en.klaytnfinder.io/v1/baobab

datbaseEndpoint:
  MYSQL_CYPRESS_01_ENDPOINT: ********.rds.amazonaws.com
  MYSQL_BAOBAB_01_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_CYPRESS_0201_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_CYPRESS_0202_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_CYPRESS_0203_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_CYPRESS_0204_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_CYPRESS_0205_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_BAOBAB_02_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_CYPRESS_03_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_BAOBAB_03_ENDPOINT: ******.rds.amazonaws.com
  MYSQL_COMMON_ENDPOINT: ******.rds.amazonaws.com

openSearch:
  OPEN_SEARCH_URL: https://******.ap-northeast-2.es.amazonaws.com

redis:
  REDIS_ENDPOINT: ***.clustercfg.apn2.cache.amazonaws.com:6379

zookeeper:
  ZOOKEEPER_ENDPOINT: zk.****.io:2181

apiEndpoint:
  COMPILER_API_ENDPOINT: https://compiler-api.******.io/
  PAPI_API_CYPRESS_ENDPOINT: https://test-prod-cypress-papi.******.io
  PAPI_API_BAOBAB_ENDPOINT: https://test-prod-baobab-papi.******.io
apiKeys:
  CMC_PRO_API_KEY: ******

api:
  front:
    ingress: #alb.ingress.kubernetes.io/group.name
    images:
      repository: public.ecr.aws/y1e5c4k9/finder-api
      tag: public-3b7017c3c578da343833d6d6d7a070517e700fbb
    host: test-prod-baobab-api.klaytnfinder.io
    replicas: 1
    env:
      - name: SPRING_PROFILES_ACTIVE
        value: prodBaobab,api
    resources:
      requests:
        cpu: 1000m
        memory: 2Gi
      limits:
        cpu: 1000m
        memory: 2Gi
  papi:
    images:
      ingress: #alb.ingress.kubernetes.io/group.name
      repository: public.ecr.aws/y1e5c4k9/finder-api
      tag: public-3b7017c3c578da343833d6d6d7a070517e700fbb
    host: test-prod-baobab-papi.klaytnfinder.io
    replicas: 1
    env:
      - name: SPRING_PROFILES_ACTIVE
        value: prodBaobab,papi
    resources:
      requests:
        cpu: 1000m
        memory: 2Gi
      limits:
        cpu: 1000m
        memory: 2Gi
  oapi:
    ingress: #alb.ingress.kubernetes.io/group.name
    images:
      repository: public.ecr.aws/y1e5c4k9/finder-oapi
      tag: public-06-d873c1e4b5760469a43918edd22ea17336b36db8
    host: test-prod-baobab-oapi.klaytnfinder.io
    replicas: 1
    env:
      - name: SPRING_PROFILES_ACTIVE
        value: prodBaobab
    resources:
      requests:
        cpu: 2000m
        memory: 2Gi
      limits:
        cpu: 2000m
        memory: 2Gi
worker:
  ingress: #alb.ingress.kubernetes.io/group.name
  images:
    repository: public.ecr.aws/y1e5c4k9/finder-worker
    tag: public-3b7017c3c578da343833d6d6d7a070517e700fbb
  host: test-worker-api.klaytnfinder.io
  replicas: 1
  env:
    - name: SPRING_PROFILES_ACTIVE
      value: prod
  resources:
    requests:
      cpu: 1000m
      memory: 2Gi
    limits:
      cpu: 1000m
      memory: 2Gi

compiler:
  ingress: #alb.ingress.kubernetes.io/group.name
  images:
    repository: public.ecr.aws/y1e5c4k9/finder-worker
    tag: public-3b7017c3c578da343833d6d6d7a070517e700fbb
  host: test-worker-api.klaytnfinder.io
  replicas: 1
  env:
    - name: SPRING_PROFILES_ACTIVE
      value: prod
  resources:
    requests:
      cpu: 1000m
      memory: 2Gi
    limits:
      cpu: 1000m
      memory: 2Gi

Installing with my-values.yaml file

helm install finder -n finder klaytn-finder/finder --values my-values.yaml

Getting Help

Your feedback is always welcome!