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.

Sign up for GitHub

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

Jump to bottom

Add deployment information to mkdocs, and reference eoapi-template. #114

Merged
merged 6 commits into from
Jul 18, 2023
Merged

Add deployment information to mkdocs, and reference eoapi-template. #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9c2e73
Add deployment information to mkdocs, and reference eoapi-template.
zacharyDez Jul 17, 2023
9f5993d
Fix path to eoAPI logo
zacharyDez Jul 17, 2023
5ef4f58
Reduce intro.md to limited information on getting started.
zacharyDez Jul 17, 2023
e4a08f4
Rename k8s-eoapi to eoapi-k8s to match renaming of repository name
zacharyDez Jul 17, 2023
8e17e8c
Revert intro.md to the state before this branch (749b85dc1d4568969dcd…
zacharyDez Jul 17, 2023
106135c
Update README.md
vincentsarago Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ Note: services might have incompatible dependencies which you can resolve by usi

This repository has the demonstration runtimes that are consistently updated with new functionality.

The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [k8s-eoapi](https://github.com/developmentseed/k8s-eoapi)).
The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)).

A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template).

## Contribution & Development

Expand Down
3 changes: 2 additions & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ nav:
- Home: "index.md"
- Intro: "intro.md"
- Services: "services.md"
- Development - Contributing: "contributing.md"
- Deployment: "deployment.md"
- Development - Contributing: "contributing.md"


plugins:
- search
Expand Down
6 changes: 5 additions & 1 deletion docs/src/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ hide:
- navigation
---

The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)).

A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template).

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 really explain clearly what are the option for deploying an eoAPI like system.

right now this page deployment.md is a mix of two things:

  • links to external repo (eoapi-cdk and k8s-eoapi)
  • a step-by-step how to to deploy eoapi custom demo application

IMO this is really confusing.

Possible solution

  1. create an eoapi-docs repo to host all the documentation about eoapi
  2. use the current eaopi repo as an example of how eoapi can work

cc @sharkinsspatial @zacharyDez

Copy link

Choose a reason for hiding this comment

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

I just renamed the repo to eoapi-k8s so that will have to change too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vincentsarago We can also just remove the external references if you prefer, but I thought it would be helpful for someone interested in deployment to have this information readily available.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ranchodeluxe updated the name references to the repo.

Copy link
Member

Choose a reason for hiding this comment

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

@vincentsarago I agree this is confusing. Ideally I think the eoAPI repo would have 3 deployment sections

  1. How to deploy the eoAPI demonstration runtimes locally via docker.
  2. A description of eoapi-cdk , eoapi-cdk and eoapi-template and pointers to their docs for deploying with the default runtimes they contain.
  3. How to deploy the eoAPI demonstration runtimes using a local CDK app (mostly copy and pasted from eoapi-template) that uses the eoapi-cdk constructs but with runtime overrides.

I think this is what @zacharyDez was shooting for with his PR but based on your feedback maybe we need a bit more clarification.

Copy link
Member

Choose a reason for hiding this comment

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

@sharkinsspatial yep that's it on point!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it! Will go for another iteration.

## AWS (Lambda)

An example of Cloud Stack is available for AWS (RDS for the database and Lambda for the APIs)
Expand Down Expand Up @@ -84,4 +88,4 @@ If you get an error saying that the max VPC's has been reached, this means that

## K8S

A Kubernetes chart is currently being developed at https://github.com/developmentseed/k8s-eoapi
A Kubernetes chart is currently being developed at https://github.com/developmentseed/eoapi-k8s