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

Update deployment docs #115

Merged
merged 3 commits into from
Aug 7, 2023
Merged

Update deployment docs #115

merged 3 commits into from
Aug 7, 2023

Conversation

zacharyDez
Copy link
Contributor

Add description and pointers to eoapi-template, eoapi-cdk, eoapi-k8s. Add information on running services with docker-compose to deployment section. Refactor mkdocs deployment to reference sub-repositories and follow similar formatting for k8s vs. cdk approach.

Followed recommendations from @vincentsarago and @sharkinsspatial here. Let me know if I missed interpreted anything or if you have other suggestions!

Add description and pointers to eoapi-template, eoapi-cdk, eoapi-k8s. Add information on running services with docker-compose to deployment section. Refactor mkdocs deployment to reference sub-repositories and follow similar formatting for k8s vs. cdk approach.
@zacharyDez zacharyDez added the documentation Improvements or additions to documentation label Jul 18, 2023
@zacharyDez zacharyDez self-assigned this Jul 18, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Add how to launch official services via docker-compose. Add full sentence on IaC.

[eoapi-template](https://github.com/developmentseed/eoapi-template) is an AWS CDK app that shows how to configure the [eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) constructs.

An example of Cloud Stack is available for AWS (RDS for the database and Lambda for the APIs).
Copy link
Member

Choose a reason for hiding this comment

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

I think we should remove the following section and replace with a simple eoapi-cdk example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't seem to find the equivalent for the eoAPI-k8s version. @alukach @sharkinsspatial could you put together a short getting started example for the eoapi-cdk repo?

Copy link
Member

@alukach alukach Aug 1, 2023

Choose a reason for hiding this comment

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

To help me understand what we're trying to do here...

I think we should remove the following section and replace with a simple eoapi-cdk example

@vincentsarago why do you suggest this? What do you feel is insufficient regarding what is currently written.

@zacharyDez
Copy link
Contributor Author

@vincentsarago seems like it is going a little stale. Can we keep it as is and review deployment for AWS later on based on feedback?

@vincentsarago vincentsarago self-requested a review August 7, 2023 19:41
@zacharyDez zacharyDez merged commit adaf926 into main Aug 7, 2023
2 checks passed
@zacharyDez zacharyDez deleted the docs/deployment-details branch August 7, 2023 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants