Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(helm): helm chart for privacypal #394

Merged
merged 12 commits into from
Mar 22, 2024
Merged

feat(helm): helm chart for privacypal #394

merged 12 commits into from
Mar 22, 2024

Conversation

tthvo
Copy link
Contributor

@tthvo tthvo commented Jan 25, 2024

Welcome to PrivacyPal! 👋

Fixes: #25
Fixes: #38

Description of the change:

  • Built helm chart to deploy privacypal application and create AWS resources (i.e. Lambda, RDS Postgres, and S3 Buckets).
  • Used readme-generator to create REAME for helm charts:
    • Source: https://github.com/bitnami/readme-generator-for-helm

    • How to run:

      $ git clone https://github.com/bitnami/readme-generator-for-helm
      $ cd readme-generator-for-helm && git checkout 2.5.0 # Use 2.5.0 release
      $ npm install
      $ node ./bin/index.js --values <path-to-value.yaml> \
             --readme <path-to-chart-README> \
             --schema <path-to-values.schema.json>

Motivation for the change:

See #25

How to test

Notes: If you are testing locally with AWS EKS for our QA, please select a different namespace, for example, myns-thvo. If using scripts/chart_installer.sh, set environment variable INSTALL_NAMESPACE to a namespace (e.g. myns-thvo).

The helm chart is only supported on AWS EKS with ACK controllers. Check out the SETUP.md.

  • Provision a cluster (if not):

    $ eksctl create cluster --name <cluster-name> --region <region> --profile <profile>
  • Register EKS OIDC endpoint with IAM (used for Pod Identity Webhook with AWS STS):

    $ eksctl utils associate-iam-oidc-provider \
          --cluster <cluster-name> \
          --region <region> \
          --approve --profile <profile>
  • Install an AWS load balancer (ALB) controller:

    $ cd helm-charts && bash scripts/eks/aws_lb_controller_install.sh
  • To install ack controllers (if not yet available), run:

    # For example, AWS_SERVICE=s3
    # Required controllers: s3, lambda, rds
    $ cd helm-charts && AWS_SERVICE=<service> bash scripts/eks/ack_installer.sh
  • To install the chart (i.e. create a chart release):

    $ export INSTALL_NAMESPACE=<namespace>
    $ kubectl create ns $INSTALL_NAMESPACE
    $ kubectl config set-context --current --namespace=$INSTALL_NAMESPACE
    $ cd helm-charts && bash scripts/chart_installer.sh
  • Make sure to follow the release note for post-installation steps.

@tthvo tthvo added feat New feature or request area/kubernetes Kubernetes work build Build work (e.g. container images) need-documentation Product documentation required labels Jan 25, 2024
@tthvo tthvo self-assigned this Jan 25, 2024
@tthvo tthvo linked an issue Jan 26, 2024 that may be closed by this pull request
@tthvo tthvo added the high-priority Need immediate attention label Jan 26, 2024
@tthvo tthvo force-pushed the gh-25-helm-chart branch 5 times, most recently from 8fbfcac to e8c8c39 Compare February 1, 2024 20:24
@tthvo tthvo force-pushed the gh-25-helm-chart branch 6 times, most recently from b2672c7 to b56e7d2 Compare February 10, 2024 23:26
@tthvo tthvo force-pushed the gh-25-helm-chart branch 3 times, most recently from ce08103 to fb10a82 Compare February 18, 2024 22:14
@tthvo tthvo force-pushed the gh-25-helm-chart branch 5 times, most recently from 55c8081 to 23838d5 Compare February 27, 2024 22:40
@tthvo tthvo force-pushed the gh-25-helm-chart branch 5 times, most recently from f902918 to 8addbea Compare March 5, 2024 22:20
@tthvo tthvo force-pushed the gh-25-helm-chart branch 2 times, most recently from a229734 to fbf7a74 Compare March 21, 2024 18:56
Copy link
Contributor

@MyStackOverflows MyStackOverflows left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The results speak for themselves but this is awesome Thuan! only thing was that minor typo, amazing work!

Copy link
Contributor

@MyStackOverflows MyStackOverflows left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double checked the connection tests and looks good!

@tthvo tthvo merged commit 5e26d19 into develop Mar 22, 2024
16 checks passed
@tthvo tthvo deleted the gh-25-helm-chart branch March 22, 2024 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/kubernetes Kubernetes work build Build work (e.g. container images) feat New feature or request high-priority Need immediate attention need-documentation Product documentation required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Story] TLS Termination for NextJS Application [Story] App should be able to deploy with Helm
2 participants