Skip to content

Comments

Initial draft of docker docs for runtime container#7734

Merged
mabuyo merged 20 commits intodevfrom
apollo-runtime-container-docs
Jun 24, 2025
Merged

Initial draft of docker docs for runtime container#7734
mabuyo merged 20 commits intodevfrom
apollo-runtime-container-docs

Conversation

@lambertjosh
Copy link
Contributor

@lambertjosh lambertjosh commented Jun 20, 2025

With the introduction of the MCP Server, we needed a way to easily deploy and operate all Apollo runtime services. This new combined container solves that problem and we should recommend it.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • PR description explains the motivation for the change and relevant context for reviewing
  • PR description links appropriate GitHub/Jira tickets (creating when necessary)
  • Changeset is included for user-facing changes
  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Metrics and logs are added3 and documented
  • Tests added and passing4
    • Unit tests
    • Integration tests
    • Manual tests, as necessary

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices.

  4. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@lambertjosh lambertjosh requested a review from a team as a code owner June 20, 2025 16:49
@github-actions

This comment has been minimized.

@apollo-librarian
Copy link

apollo-librarian bot commented Jun 20, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

1 new, 10 changed, 0 removed
+ graphos/routing/(latest)/self-hosted/containerization/docker-router-only.mdx
* (developer-tools)/apollo-mcp-server/(latest)/command-reference.mdx
* (developer-tools)/apollo-mcp-server/(latest)/guides/index.mdx
* (developer-tools)/kotlin/v5/testing/android-studio-plugin.mdx
* (developer-tools)/rover/ci-cd.mdx
* (developer-tools)/rover/getting-started.mdx
* graphos/routing/(latest)/configuration/cli.mdx
* graphos/routing/(latest)/self-hosted/containerization/docker.mdx
* graphos/routing/(latest)/self-hosted/containerization/index.mdx
* graphos/routing/(latest)/self-hosted/index.mdx
* graphos/routing/(latest)/_sidebar.yaml

Build ID: f9af9d812c006fccab22cb7f

URL: https://www.apollographql.com/docs/deploy-preview/f9af9d812c006fccab22cb7f

@burn2delete
Copy link
Contributor

cc: @jonathanrainer

@lambertjosh
Copy link
Contributor Author

@jonathanrainer - I made a few changes since your last review and it ended up getting larger. Can you take another look?

@abernix - can you or someone on the team take a look? I'd like to get this merged ideally Tuesday (today) to align with launch if possible, but it is not a must have.

@lambertjosh lambertjosh requested a review from abernix June 24, 2025 06:00
@abernix abernix requested a review from garypen June 24, 2025 06:01
Copy link
Contributor

@jonathanrainer jonathanrainer left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@mabuyo mabuyo left a comment

Choose a reason for hiding this comment

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

Need to address the errors in links

Comment on lines 1 to 5
Copy link
Contributor

Choose a reason for hiding this comment

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

Did we want to show this in the sidebar 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.

We probably should. How do we do that? I made a few changes to be indicate what this is. Can you review and make or propose the change to add to the sidebar?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also is there a way to get a preview deploy of these docs somewhere like netlify or GH Pages?

Copy link
Contributor

Choose a reason for hiding this comment

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

The DP is kinda hidden, it's under the tests Docs Deploy Preview, but here's the link: https://www.apollographql.com/docs/deploy-preview/11ed83ea0783a80e2f42c306/graphos/routing/self-hosted/containerization/docker

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mabuyo - do we need to do anything to get it to show in the sidebar?

@lambertjosh lambertjosh force-pushed the apollo-runtime-container-docs branch from 75ed7c5 to 7cab08b Compare June 24, 2025 15:29
@lambertjosh lambertjosh force-pushed the apollo-runtime-container-docs branch from 7cab08b to 719f4ed Compare June 24, 2025 16:34
@mabuyo mabuyo enabled auto-merge June 24, 2025 18:52
@mabuyo mabuyo merged commit 6ce4427 into dev Jun 24, 2025
15 checks passed
@mabuyo mabuyo deleted the apollo-runtime-container-docs branch June 24, 2025 19:54
@abernix abernix mentioned this pull request Jul 1, 2025
BrynCooke pushed a commit that referenced this pull request Aug 1, 2025
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.

6 participants