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

INF-465: Cloud Endpoints Portal Deprecation - move observatory-api container #610

Merged
merged 7 commits into from
Mar 22, 2023

Conversation

alexmassen-hane
Copy link
Contributor

@alexmassen-hane alexmassen-hane commented Mar 8, 2023

On March 21st, the Developer portal for Google APIs is being deprecated and we will not have access to a production API gui where we can easily check or modify Observatory API data.

This PR is to move the deployment of the observatory-api container from Google's Cloud Run service to a local docker container that runs on the main and worker VM of the deployed Observatory Platform. In doing so, we will be able to access the Swagger UI by ssh'ing into the main VM and going to http://localhost:5002/ui . The local observatory-api container will still have access to the Cloud DB instance, where all of the release and workflow data is stored.

The API gateway and the serverless VPC service have also been removed as they were only needed for the Cloud Run instance to access data from the Cloud DB instance that holds the observatory API data.

@alexmassen-hane alexmassen-hane force-pushed the INF-465-cloud-endpoints-portal-deprecation branch from c053fa2 to d15b54f Compare March 16, 2023 05:34
@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.07 ⚠️

Comparison is base (8598e24) 91.97% compared to head (9710ee6) 91.91%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #610      +/-   ##
===========================================
- Coverage    91.97%   91.91%   -0.07%     
===========================================
  Files           48       48              
  Lines         6640     6565      -75     
  Branches       758      753       -5     
===========================================
- Hits          6107     6034      -73     
- Misses         413      415       +2     
+ Partials       120      116       -4     
Impacted Files Coverage Δ
...servatory-platform/observatory/platform/cli/cli.py 83.42% <ø> (+0.91%) ⬆️
...tform/observatory/platform/cli/generate_command.py 79.47% <ø> (-0.78%) ⬇️
...form/observatory/platform/cli/terraform_command.py 83.90% <ø> (+1.68%) ⬆️
...latform/observatory/platform/observatory_config.py 96.07% <ø> (-0.22%) ⬇️
...bservatory/platform/terraform/terraform_builder.py 90.00% <ø> (-1.84%) ⬇️
observatory-api/observatory/api/server/api.py 100.00% <100.00%> (ø)
...ory-api/observatory/api/server/openapi_renderer.py 100.00% <100.00%> (ø)
...orm/observatory/platform/docker/platform_runner.py 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@alexmassen-hane alexmassen-hane marked this pull request as ready for review March 16, 2023 08:37
@jdddog jdddog self-requested a review March 21, 2023 21:26
Copy link
Contributor

@jdddog jdddog left a comment

Choose a reason for hiding this comment

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

Thanks Alex, your PR looks good, I've just got a few small suggestions.

These files can be removed:

  • .github/workflows/build-observatory-api.yml
  • observatory-api/Dockerfile
  • observatory-api/requirements.cloudrun.txt

Then in terraform_builder.py, the function make_open_api_template and any calls to it can be removed as well as the import for OpenApiRenderer. This isn't needed anymore since the openapi.yaml file is rendered when the API server is started.

@@ -16,6 +16,7 @@
version: '3.8'

x-environment: &environment

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

@jdddog jdddog self-requested a review March 22, 2023 19:06
Copy link
Contributor

@jdddog jdddog left a comment

Choose a reason for hiding this comment

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

Thanks Alex, the changes look good.

@jdddog jdddog merged commit 7d9d72a into develop Mar 22, 2023
@jdddog jdddog deleted the INF-465-cloud-endpoints-portal-deprecation branch March 22, 2023 19:07
jdddog pushed a commit that referenced this pull request Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants