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

Add tips for debugging failed deployments #2458

Merged
merged 2 commits into from
Jun 25, 2023

Conversation

sarayourfriend
Copy link
Collaborator

@sarayourfriend sarayourfriend commented Jun 21, 2023

Fixes

Fixes #1923 by @sarayourfriend

cc @obulat In case you can think of anything that should also be included

Description

Adds a link out to the logging documentation, instructions for how to find the ECS events log for a service (and links to ECS documentation about events), and instructions for re-running a failed deployment.

Testing Instructions

Read the documentation, ensure it is accurate. Once the preview is deployed, you can read the documentation here: https://docs.openverse.org/_preview/2458/general/deployment.html

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟧 priority: high Stalls work on the project or its dependents 📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: documentation Related to Sphinx documentation labels Jun 21, 2023
@sarayourfriend sarayourfriend requested a review from a team as a code owner June 21, 2023 02:01
@sarayourfriend sarayourfriend requested review from krysal and obulat June 21, 2023 02:01
@github-actions
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/2458

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Love the formatting and pictures there.
Thank you for adding the docs! I don't have anything to add.

Comment on lines +104 to +105
An additional resource that is often helpful other than logs is the events list for a
service. You can find that under the "Events" tab of the ECS service's page:
Copy link
Member

Choose a reason for hiding this comment

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

Good tip 💯 I sometimes forget AWS CLI provides extra things to investigate.

@sarayourfriend sarayourfriend merged commit 3e982b5 into main Jun 25, 2023
@sarayourfriend sarayourfriend deleted the add/failed-deployment-tips branch June 25, 2023 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Runbook for debugging failed deployments
3 participants