Skip to content

Commit

Permalink
Update QuickLaunch README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RamanDamayeu authored Dec 19, 2023
1 parent e2229b9 commit 65dfa5a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion charts/odd-quicklaunch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ More info at https://github.com/opendatadiscovery/odd-platform
| Helm chart | 709825985650.dkr.ecr.us-east-1.amazonaws.com/provectus/odd-quicklaunch:1.0.13 |
| Container Image | 709825985650.dkr.ecr.us-east-1.amazonaws.com/provectus/odd:0.19.0 |
| 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 | 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/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 |
| 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/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]. Double check that if, for example, 'Load Balancer URLs' for the server looks like this 'ac3a9a5400b1d457dacba505325901cd-951018742.us-east-1.elb.amazonaws.com', the url in you browser would like this 'http://ac3a9a5400b1d457dacba505325901cd-951018742.us-east-1.elb.amazonaws.com'. 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 |
Expand Down

0 comments on commit 65dfa5a

Please sign in to comment.