Skip to content

Commit

Permalink
Update readme with AWS Marketplace relevant information.
Browse files Browse the repository at this point in the history
  • Loading branch information
Raman Damayeu committed Nov 15, 2023
1 parent 994091a commit 1608036
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions charts/odd-quicklaunch/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Helm Chart for AWS Marketplace QuickLaunch

For AWS Marketplace with product offering with Helm chart delivery method and support of QuickLaunch we need to prepare a parent helm chart that has to child charts: odd-platform and postgresql database for it.
This approach would benefit from utilizing (QuickLaunch)[https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-configuring-a-product.html#buyer-launch-container-quicklaunch]: first AWS Marketplace creates a new EKS cluster with its built-in CloudFormation for EKS and in the same stack it deploys mentioned Helm chart that should be stored at AWS ECR managed by AWS Marketplace that was created during new product registration.

There are some differences to the base helm chart of odd-platform that should reflect new approach of AWS Marketplace QuickLaunch.

1. configmap.yaml template for odd-platform has been changed
```
Expand Down Expand Up @@ -36,14 +42,21 @@ metadata:
There is a restriction of 50 characters to be propagated with AWS Marketplace QuickLaunch Override parameter key.
So we have to use new shorter one.


# Steps to update version
Change tags for odd-platform and chart version according to the actual state. In this example odd-platform version 0.19.0 and chart version 1.0.8 are used.
```commandline
$ aws ecr get-login-password --region us-east-1 --profile ${AWSMarketplaceProfile} | docker login --username AWS --password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
$ docker pull ghcr.io/opendatadiscovery/odd-platform:0.19.0
$ docker tag ghcr.io/opendatadiscovery/odd-platform:0.19.0 709825985650.dkr.ecr.us-east-1.amazonaws.com/provectus/odd:0.19.0
$ docker push 709825985650.dkr.ecr.us-east-1.amazonaws.com/provectus/odd:0.19.0
$ helm dependency update .
$ helm package .
$ aws ecr get-login-password --region us-east-1 --profile ${AWSMarketplaceProfile} | helm registry login --username AWS --password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
$ export HELM_EXPERIMENTAL_OCI=1 && helm push ./odd-quicklaunch-1.0.8.tgz oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/provectus/
```

Version Information in AWS Marketplace (Examples)
# Version Information in AWS Marketplace (Examples)

| Property | Value |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -53,12 +66,12 @@ Version Information in AWS Marketplace (Examples)
| Container Image | 709825985650.dkr.ecr.us-east-1.amazonaws.com/provectus/odd:0.19.0 |
| Delivery option title | Open Data Discovery Platfrom Quick Launch |
| Delivery option description | This delivery method allows to deploy odd-platform and its database with one helm chart on newly created AWS EKS cluster with QuickLaunch |
| Usage instructions | Go to https://blog.opendatadiscovery.org/ to learn how to deploy odd-collectors. |
| Usage instructions | Utilizing QuickLaunch through CloudFormation enables a hassle-free setup of the Open Data Discovery platform. QuickLaunch streamlines the process by establishing a new EKS cluster and deploying a pre-set Helm chart that includes the odd-platform and a corresponding Postgresql database. You can explore the Chart's details and its AWS Marketplace inclusion at ODD Helm Chart GitHub - https://github.com/opendatadiscovery/charts/charts/tree/main/charts/odd-quicklaunch. When setting up, choose a name of your liking for the stack and the EKS cluster (for example, you might use 'ODD-EKS' for both). Keep the 'Helm release name' as 'odd-quicklaunch'. For 'postgresPassword', select a secure password that will be used by the 'postgres' admin in the database and for connecting the odd-platform to the database. For 'AllowedIPAddresses', input a CIDR-formatted IP range or single IP (like 8.8.8.8/32) that will have access to the odd-platform. Determine your IP address at resources such as https://whatismyipaddress.com/. Remember, this IP might change with network reconfigurations, and you'll need to update access rules accordingly, as guided here: https://blog.opendatadiscovery.org/quick-launch-of-open-data-discovery-odd-platform-on-amazon-elastic-kubernetes-service-eks-5a0a4489e492. The entire setup process should take approximately 30-40 minutes. Once completed, navigate to the EKS section in the AWS Console. Locate your named EKS cluster, and under 'Resources', proceed to 'Service and networking', then 'Services'. Here, find and click on 'odd-quicklaunch-odd-platform'. The service page will display 'Load Balancer URLs', leading to your odd-platform. Note that accessing these URLs defaults to an HTTPS protocol, which QuickLaunch does not support. Ensure you access it via HTTP, like http://[your-load-balancer-URL]. Important Considerations: This setup only supports HTTP, not HTTPS, and is not secure for transmitting sensitive data. For production, consider enabling HTTPS. The database data is not persistent. A restart of the postgres pod will erase data, so for production use, consider a persistent postgresql setup. This setup excludes odd collectors and adapters, meaning no automatic data ingestion. To add these, refer to our blog post https://blog.opendatadiscovery.org/introducing-odd-collector-configuration-for-aws-eks-bcc2bf04ae7e. We are always happy to assist if you need any help! Just reach out to our community at ODD Community Slack https://go.opendatadiscovery.org/slack |
| Supported services | Amazon Elastic Kubernetes Service (EKS) |
| Helm release name | odd-quicklaunch |
| QuickLaunch | Enable QuickLaunch |
| QuickLaunch | Enable QuickLaunch |

Override parameters
# Override parameters

| Override parameter | Override parameter key | Override parameter default | CloudFormation parameter name | CloudFormation parameter description | Hide passwords and secrets |
| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
Expand Down

0 comments on commit 1608036

Please sign in to comment.