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

feat: docker image tags documentation + tweaks #26923

Merged
merged 25 commits into from
Feb 2, 2024
Merged

feat: docker image tags documentation + tweaks #26923

merged 25 commits into from
Feb 2, 2024

Conversation

mistercrunch
Copy link
Member

@mistercrunch mistercrunch commented Jan 31, 2024 •
edited
Loading

This PR adds a new page to the docs under "Installation and Configuration" titled "Docker Images and Tags"

It also:

  • adds new tags for PRs as in PR_5287 + unit tests for that
  • points the docker-compose-non-dev, which assumes prod to the lean build (latest) since the dev build isn't as secure
  • adds a --force-latest flag to the build_docker.py script
  • fixes a merge conflict around ephemeral builds, where I had refactored the command, but it moved to a new location so I have to re-refactor it

For the text, I have GPT proof read it and I rendered it locally, and took a screenshot
Screenshot 2024-01-31 at 10 48 03 AM

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Jan 31, 2024
@codecov Codecov
Copy link

codecov bot commented Jan 31, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fdff6d8) 67.19% compared to head (a270ddb) 67.20%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #26923   +/-   ##
=======================================
  Coverage   67.19%   67.20%           
=======================================
  Files        1899     1899           
  Lines       74346    74346           
  Branches     8263     8263           
=======================================
+ Hits        49960    49961    +1     
+ Misses      22337    22336    -1     
  Partials     2049     2049
Flag Coverage Δ
mysql 77.98% <ø> (-0.03%) ⬇️
postgres 78.10% <ø> (ø)
python 78.24% <ø> (+<0.01%) ⬆️
sqlite 77.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rusackas rusackas requested a review from sfirke January 31, 2024 23:05
@mistercrunch
Copy link
Member Author

/testenv up

@github-actions GitHub Actions
Copy link
Contributor

@mistercrunch Ephemeral environment spinning up at http://34.220.34.38:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

@mistercrunch
Copy link
Member Author

mistercrunch commented Jan 31, 2024 •
edited
Loading

Actions run their master counterpart, I think it's a security feature but it's super confusing... It should only do this in PRs opened from forks... As a result running this command triggers the action prod, and we can't test this one.

@mistercrunch mistercrunch mentioned this pull request Jan 31, 2024
Closed
3 tasks
@pull-request-size pull-request-size bot added size/L and removed size/M labels Feb 1, 2024
sfirke
sfirke reviewed Feb 1, 2024
View reviewed changes
Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

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

Should docs have manual line breaks or should that just happen automatically? I pointed out an instance of that and linked to a recent comment from @john-bodley on this.

Otherwise a few suggestions for clarity but overall this looks great 👍

docs/README.md Show resolved Hide resolved
docs/docs/installation/docker.mdx Outdated Show resolved Hide resolved
docs/docs/installation/docker.mdx Outdated Show resolved Hide resolved
docs/docs/installation/docker.mdx Show resolved Hide resolved
docs/docs/installation/docker.mdx Outdated Show resolved Hide resolved
sfirke
sfirke approved these changes Feb 1, 2024
View reviewed changes
Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

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

docs LGTM

eschutho
eschutho reviewed Feb 1, 2024
View reviewed changes
docs/docs/installation/docker.mdx
```

Presumably, `linux/arm64/v8` would be more optimized for this generation
of chips, but less compatible across the ARM ecosystem.
Copy link
Member

Choose a reason for hiding this comment

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

This doc is super helpful. 🙌

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm just not sure if it's 100% true ... seemed to work for me

eschutho
eschutho reviewed Feb 1, 2024
View reviewed changes
scripts/build_docker.py Outdated
@@ -205,12 +208,14 @@ def get_docker_command(
)
@click.option("--build_context_ref", help="a reference to the pr, release or branch")
@click.option("--dry-run", is_flag=True, help="Run the command in dry-run mode.")
@click.option("--force-latest", is_flag=True, help="Run the command in dry-run mode.")
Copy link
Member

Choose a reason for hiding this comment

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

Is the help string copy pasta?

Copy link
Member Author

Choose a reason for hiding this comment

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

oopsy

craig-rueda
craig-rueda approved these changes Feb 1, 2024
View reviewed changes
Copy link
Member

@craig-rueda craig-rueda left a comment

Choose a reason for hiding this comment

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

LGTM

@mistercrunch mistercrunch merged commit 6b0d8ed into master Feb 2, 2024
34 checks passed
@mistercrunch mistercrunch deleted the docker_docs branch February 2, 2024 02:04
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 2, 2024

Ephemeral environment shutdown and build artifacts deleted.

@dnskr dnskr mentioned this pull request Feb 3, 2024
Merged
9 tasks
sfirke added a commit to sfirke/superset that referenced this pull request Mar 22, 2024
@mistercrunch @sfirke
feat: docker image tags documentation + tweaks (apache#26923)
4ef9ac8 
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
@mistercrunch
Copy link
Member Author

@supersetbot orglabel

@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 4.0.0 labels Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eschutho eschutho eschutho left review comments

@rusackas rusackas rusackas approved these changes

@craig-rueda craig-rueda craig-rueda approved these changes

@sfirke sfirke sfirke approved these changes

@dpgaspar dpgaspar Awaiting requested review from dpgaspar dpgaspar is a code owner

@villebro villebro Awaiting requested review from villebro villebro is a code owner

@geido geido Awaiting requested review from geido geido is a code owner

@betodealmeida betodealmeida Awaiting requested review from betodealmeida betodealmeida is a code owner

@nytai nytai Awaiting requested review from nytai nytai is a code owner

@john-bodley john-bodley Awaiting requested review from john-bodley john-bodley is a code owner

@kgabryje kgabryje Awaiting requested review from kgabryje kgabryje is a code owner

Assignees
No one assigned
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels doc Namespace | Anything related to documentation preset-io size/L 🚢 4.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@mistercrunch @rusackas @craig-rueda @eschutho @sfirke