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

chore(docs): docker instructions use docker compose instead of the deprecated docker-compose #30030

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

rusackas
Copy link
Member

SUMMARY

docker-compose isn't included in the newest installations of Docker, and is on the path toward deprecation, apparently.

This PR makes the relevant changes to move us into a post-docker-compose world, where we now type docker compose.

I will now close all 49 open Issues that mention docker-compose. Kidding!!!

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Aug 27, 2024
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.

Nice improvement! I have a few minor nits, then this is good to merge.

@@ -32,9 +32,9 @@ assists people when migrating to a new version.
`requirements/` folder. If you use these files for your builds you may want to double
check that your builds are not affected. `base.txt` should be the same as before, though
`development.txt` becomes a bigger set, incorporating the now defunct local,testing,integration, and docker
- [27434](https://github.com/apache/superset/pull/27434/files): DO NOT USE our docker-compose.\*
Copy link
Member

Choose a reason for hiding this comment

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

When talking about the files, they don't have spaces in the filenames so docker-compose is still correct IMO

and can't support requirements for **high availability**, we do not support nor recommend
using our `docker-compose` constructs to support production-type use-cases. For single host
using our `docker- ompose` constructs to support production-type use-cases. For single host
Copy link
Member

Choose a reason for hiding this comment

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

You deleted the wrong character 😆

[docker-compose](https://docs.docker.com/compose/), and
[git](https://git-scm.com/) installed.
Note that this documentation assumes that you have [Docker](https://www.docker.com) and
[git](https://git-scm.com/) installed. Note also that we used to use `docker-compose` but that
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[git](https://git-scm.com/) installed. Note also that we used to use `docker-compose` but that
[git](https://git-scm.com/) installed. Superset has switched from using the deprecated `docker-compose` to `docker compose`.

[git](https://git-scm.com/) installed.
Note that this documentation assumes that you have [Docker](https://www.docker.com) and
[git](https://git-scm.com/) installed. Note also that we used to use `docker-compose` but that
is on the path to deprecation so we now use `docker compose` instead.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
is on the path to deprecation so we now use `docker compose` instead.

Copy link
Member

Choose a reason for hiding this comment

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

This suggestion goes with the one immediately above it, it should be a combined suggestion. Kind of confusing rn.

@@ -40,6 +40,7 @@ container images and will load up some examples. Once all containers
are downloaded and the output settles, you're ready to log in.

⚠️ If you get an error message like `validating superset\docker-compose-image-tag.yml: services.superset-worker-beat.env_file.0 must be a string`, you need to update your version of `docker-compose`.
Note that `docker-compose` is on the path to deprecation and you should now use `docker compose` instead.
Copy link
Member

Choose a reason for hiding this comment

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

I think instead of adding this line, you could just replace docker-compose in the preceding line with docker compose

@sfirke sfirke changed the title chore(docs): docker-compose is dead. Long live docker compose chore(docs): docker instructions use docker compose instead of the deprecated docker-compose Aug 28, 2024
@rusackas rusackas merged commit 4fe3000 into master Aug 29, 2024
37 of 39 checks passed
@rusackas rusackas deleted the docker-compose-is-dead-long-live-docker-compose branch August 29, 2024 22:42
@sfirke
Copy link
Member

sfirke commented Aug 30, 2024

@rusackas did you see my suggested changes above? At least one should definitely get fixed, where it now says "docker- ompose" in the docs.

My bad for marking it "approve" when I also had suggested fixes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Namespace | Anything related to documentation preset-io size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants