feat(helm): helm chart for privacypal (#394)

helm-charts/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2023] [Privacypal Authors]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

helm-charts/README.md

@@ -0,0 +1 @@
+charts/privacypal/README.md

helm-charts/SETUP.md

@@ -0,0 +1,166 @@
+## REQUIREMENTS
+
+- [`kubectl`](https://kubectl.docs.kubernetes.io/installation/kubectl/binaries/) (v1.27+) or [`oc`](https://docs.openshift.com/container-platform/4.14/cli_reference/openshift_cli/getting-started-cli.html)
+- [`aws`](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) with permissions to create IAM resources (IAM user not required)
+- [`eksctl`](https://eksctl.io/installation/)
+- [`helm`](https://helm.sh/docs/intro/install/)
+- [`jq`](https://jqlang.github.io/jq/)
+- [`podman`](https://podman.io/docs/installation) or [`docker`](https://docs.docker.com/engine/install/)
+- [AWS EKS Instance](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html) (Kubernetes v1.27+) with Kubeadmin access
+
+## Amazon Elastic Kubernetes Service (AWS EKS)
+
+**Note:** The application currently supports only AWS EKS with Kubernetes v1.27+. Please ensure an EKS instance is available before proceeding.
+
+To list available clusters, run:
+
+```bash
+aws eks list-clusters --region <region>
+```
+
+To create a cluster, if required, run:
+
+```bash
+eksctl create cluster --name <cluster-name> --region <region-code>
+```
+
+If you already have a cluster or at any time need to update kubeconfig, run:  
+
+```bash
+aws eks update-kubeconfig --region <region-code> --name <cluster-name>
+```
+
+**Notes:**
+
+- If you are using another aws profile other than `default`, specify the `--profile <profile-name>` in your `aws`/`eksctl` command.
+- If you would like to use another config file rather than `$HOME/.kube/config`, set `KUBECONFIG=<path-to-kube-config>`.
+
+## OIDC Identity Provider
+
+Create an OpenID Connect (OIDC) identity provider for your EKS cluster using the `eksctl utils` command:
+
+```bash
+eksctl utils associate-iam-oidc-provider --cluster <eks cluster name> --region <region-code> --approve
+```
+
+This allows service accounts within the EKS cluster to authenticate with AWS services.
+
+## ACK Controllers
+
+The EKS instance must be properly configured with AWS Controllers for Kubernetes (ACK). These controllers are responsible for managing AWS resources via Kubernetes custom resource.
+
+The ACK controllers are available for installation via Helm Charts. Follow the [ACK documentations](https://aws-controllers-k8s.github.io/community/docs/community/overview/) to set up IAM resources and installation step.
+
+This repository also includes a utility script `ack_installer.sh` to automate the entire process.
+
+```bash
+EKS_CLUSTER_NAME=<cluster-name> AWS_SERVICE=s3 bash ack_installer.sh
+```
+
+To verify whether the controller is installed sucessfully, check if all controller pods are running:
+
+```bash
+$ kubectl get pods -n ack-system
+NAME                                                  READY   STATUS    RESTARTS   AGE
+ack-ec2-controller-ec2-chart-588f67f4d-44l57          1/1     Running   0          5d19h
+ack-lambda-controller-lambda-chart-7d44454dbb-lb67c   1/1     Running   0          5d22h
+ack-rds-controller-rds-chart-8bffcb97c-llttr          1/1     Running   0          5d22h
+ack-s3-controller-s3-chart-65bd8564b4-9h8dl           1/1     Running   0          9d
+```
+
+The required ACK Controllers: `s3`, `lambda`, `rds`, `ec2`.
+
+## Load Balancing Controller
+
+If deploying the application with `Ingress`, you must install AWS Load Balancing Controller. The controller is responsible for provisioning AWS Load Balancer for the application.
+
+This repository also includes a utility script `aws_lb_controller_install.sh` to automate the entire process.
+
+```bash
+EKS_CLUSTER_NAME=<cluster-name> bash aws_lb_controller_install.sh
+```
+
+**Note:** IAM Role for AWS Load Balancer might already exist. In that case, proceed to install Controller with Helm Chart.
+
+## TLS Requirements
+
+As of now, the chart must be installed with Ingress enabled with TLS (i.e. AWS Cognito requires callbacks with `https` scheme).
+
+TLS Termination occurs at AWS Load Balancer. One must request an ACM Public Certicate with a valid custom domain. See [AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) for more details.
+
+
+Then, add a tls annotation to the Ingress object when installing the chart as follow:
+
+```bash
+helm install my-app ./charts/privacypal \
+	--set web.ingress.annotations."alb\.ingress\.kubernetes\.io/certificate-arn"="<arn>"
+```
+
+## Elastic Container Registrys (AWS ECR)
+
+AWS Lambda service requires source images to be available in private ECR repositories. You can create one with:
+
+```bash
+aws ecr create-repository --region <region> --repository-name <repo-name>
+```
+
+Due to this requirement, the chart does not specify default image configurations for the lambdas. Consequently, you must configure them at the installation time, for example:
+
+```bash
+helm install my-app ./charts/privacypal \
+    --set lambda.videoProcessor.image.repository="<my-lambda-0-ecr-repository>" \
+    --set lambda.videoConversion.image.repository="<my-lambda-1-ecr-repository>"
+```
+
+## AWS IAM Roles
+
+The application components must be attached with corresponding IAM roles with sufficient permissions to function properly .
+
+|Components|Required Permissions|
+|:--|:--|
+|Web Application|Read/Write S3 Buckets, Get Lambdas, FullAccess Cognito|
+|Video Processor Lambda|Basic Execution, Read/Write S3 Buckets, FullAccess Rekcognito|
+|Video Conversion Lambda|Basic Execution, Read/Write S3 Buckets|
+
+Then, configure IAM roles for app components as followed:
+
+```bash
+helm install my-app ./charts/privacypal \
+    --set lambda.videoProcessor.iamRole="<processor-role>" \
+    --set lambda.videoConversion.iamRole="<conversion-role>" \
+    --set serviceAccount.annotations."eks\.amazonaws\.com/role-arn"="<web-role>"
+```
+
+## AWS Cognito Configurations
+
+The application utilizes AWS Cognito to authenticate app users. Currently, the chart only support manual Cognito setup. Follow the [documentation](https://aws.amazon.com/cognito/getting-started/) to create a User Pool.
+
+
+Then, create a Kubernetes Secret to store AWS Cognito configurations:
+
+- Create a text file (e.g. `cognito_secret.k8s.conf`)with the following contents. Fill the values with your Cognito information.
+    ```bash
+    COGNITO_CLIENT=<client>
+    COGNITO_CLIENT_SECRET=<secret>
+    COGNITO_POOL_ID=<id>
+    ```
+- Create a Secret:
+    ```bash
+    kubectl create secret generic <secret-name> \
+        --from-env-file=./cognito_secret.k8s.conf
+    ```
+
+At the installation time, specify the secret to chart as followed:
+
+```bash
+helm install my-app ./charts/privacypal \
+    --set auth.cognito.cognitoSecretName="<secret-name>"
+```
+
+**Note:** The application URL must be added to Cognito App Client. See chart's release note for more details.
+
+## Post-Installation Requirements
+
+Due to limitations that AWS Lambda ARNs are not available at installation time, you must patch the S3 bucket objects with Lambda ARNs after installation.
+
+Follow the chart's release note to complete the post installation steps.

helm-charts/chart_schema.yaml

@@ -0,0 +1,21 @@
+name: str()
+home: str(required=False)
+version: str()
+appVersion: any(str(), num(), required=False)
+description: str(required=False)
+keywords: list(str(), required=False)
+sources: list(str(), required=False)
+maintainers: list(include('maintainer'), required=False)
+icon: str(required=False)
+apiVersion: str(required=False)
+engine: str(required=False)
+condition: str(required=False)
+tags: str(required=False)
+deprecated: bool(required=False)
+kubeVersion: str(required=False)
+annotations: map(str(), str(), required=False)
+---
+maintainer:
+  name: str(required=False)
+  email: str(required=False)
+  url: str(required=False)