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

First commits #5

Merged
merged 40 commits into from
Aug 22, 2023
Merged

First commits #5

merged 40 commits into from
Aug 22, 2023

Conversation

king-alexander
Copy link
Collaborator

@king-alexander king-alexander commented Feb 14, 2023

🗣 Description

These are the first commits towards a repository decomposition for the Admiral. They generally pull in Admiral's Docker components and change defaults inherited from the skeleton repository.

💭 Motivation and context

It's desirable to separate the containerization logic from a project's content. This pull request is a step towards decomposing Admiral into smaller, more manageable repositories.

🧪 Testing

I modified the standard tests inherited from cisagov/skeleton-docker to cover my changes to the Docker configuration. Not all tests were easy to modify. In particular, the main_container tests do not transfer well, as there is no main container in the Docker composition. Implementing these tests is scoped as future work in #6.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All future TODOs are captured in issues, which are referenced
    in code comments.
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge checklist

  • Revert dependencies to default branches.
  • Finalize version.

✅ Post-merge checklist

  • Add a tag or create a release.

@king-alexander king-alexander added documentation This issue or pull request improves or adds to documentation docker Pull requests that update Docker code labels Feb 14, 2023
@king-alexander king-alexander force-pushed the first-commits branch 4 times, most recently from cdc82f2 to 93969b2 Compare February 23, 2023 17:17
@king-alexander king-alexander marked this pull request as ready for review February 23, 2023 17:28
@dav3r
Copy link
Member

dav3r commented Feb 24, 2023

FYI, the linting failures (here and here) should be resolved after #7 has been approved and merged into this branch.

Copy link
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

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

Before you make any other changes please update the image name:

IMAGE_NAME: cisagov/example

Dockerfile Outdated Show resolved Hide resolved
@dav3r
Copy link
Member

dav3r commented Feb 24, 2023

@king-alexander Now that #7 has been merged, you should pull those changes in to this branch and deconflict them. Before you do that though, make sure you do what @mcdonnnj said in his comment. That should get you closer to passing all of the checks in this PR.

Dockerfile Outdated Show resolved Hide resolved
@dav3r
Copy link
Member

dav3r commented Feb 24, 2023

Before you make any other changes please update the image name:

IMAGE_NAME: cisagov/example

BTW, per our convention, the image should be called admiral, not admiral-docker.

Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

Noting a few more items:

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
In other words, direct this Dockerfile to install source code and
dependencies for the admiral python library.
Here we change the entrypoint to "admiral" and remove various
instructions this image doesn't need.
Define the secrets that this Docker composition uses (and remove the one
it doesn't).
@king-alexander
Copy link
Collaborator Author

I dropped support for all platforms except linux/amd64 and linux/arm64 in 58ba017. They should be reenabled after https://github.com/cisagov/skeleton-docker is updated to address the rust compiler issue.

Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

I think this is looking real solid now - nice work! 🤠

Copy link
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

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

I have one minor question.

Dockerfile Outdated Show resolved Hide resolved
@king-alexander king-alexander self-assigned this Mar 22, 2023
Copy link
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

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

Strong work!

@dav3r
Copy link
Member

dav3r commented Apr 14, 2023

@mcdonnnj I believe this PR is just waiting on your re-review.

@jsf9k
Copy link
Member

jsf9k commented Aug 17, 2023

@mcdonnnj - Why is Lineage not generating a PR for this repo? The develop branch is missing the latest commits from the skeleton.

@dav3r dav3r mentioned this pull request Aug 18, 2023
2 tasks
@mcdonnnj
Copy link
Member

@king-alexander Please either rebase on or merge develop now that #12 has been merged. This should put you in position to pass tests with this PR.

This commit instantiates a Docker client with the Docker Compose file path and the
project name. It also comments out the main container configuration,
which causes tests to fail per #6.
Uses the python_on_whales syntax and comments out test_wait_for_exits,
which requires a main container.
@king-alexander king-alexander dismissed mcdonnnj’s stale review August 22, 2023 14:51

I made the requested change and asked Nick to re-review as time permits. If he has more suggestions, I will address them in a new pull request.

@king-alexander king-alexander merged commit d69c24f into develop Aug 22, 2023
10 checks passed
@king-alexander king-alexander deleted the first-commits branch August 22, 2023 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Pull requests that update Docker code documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace Celery Flower Image Separate Docker components
4 participants