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

docs: Add podman and log mentions in developing-locally #4965

Merged
merged 2 commits into from
Jan 3, 2023

Conversation

tomasfarias
Copy link
Contributor

@tomasfarias tomasfarias commented Jan 2, 2023

Changes

Podman and podman-compose are valid alternatives to Docker and docker compose respectively. This commit adds mentions to Podman where relevant informing developers they may choose it as an alternative that doesn't require root privileges.

Moreover, I added a small mention about ClickHouse logs as the container does not log to stdin, but to a local file. Knowing where these log files are can be useful when debugging setup issues.

Checklist

  • Titles are in sentence case
  • Feature names are in sentence case too
  • Words are spelled using American English
  • I have checked out our style guide

Podman and podman-compose are valid alternatives to Docker and docker
compose respectively. This commit adds mentions to Podman where
relevant informing developers they may choose it as an alternative that
doesn't require root privileges.

Moreover, I added a small mention about ClickHouse logs as the
container does not log to stdin, but to a local file. Knowing where
these log files are can be useful when debugging setup issues.
@vercel
Copy link

vercel bot commented Jan 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
posthog ✅ Ready (Inspect) Visit Preview Jan 3, 2023 at 8:43AM (UTC)

@tomasfarias
Copy link
Contributor Author

tomasfarias commented Jan 3, 2023

Thanks for the review comments @Twixes. I agree with all of them, so expect a new commit shortly.

I also would like to add more details on the issue with Podman (as I looked into it yesterday after work):

TLDR: #docker bases their /etc/hosts on the container's /etc/hosts and #podman uses the host's. #Podman 4.1 added the option to configure which /etc/hosts file to use as a base (using base_hosts_file in containers.conf) but the default remained the host's. containerd would be patched to match this behavior as it "seems to be more correct" (haven't looked into this).

Finally, there is an open issue to add a CLI flag to set base_hosts_file, which would improve UX (IMO).

So, I can be more specific and mention the Podman version with the issue (4.1) instead of "in newer versions".

1. More specifically defined the Podman version that can use a host
machine's /etc/hosts.

2. Removed a paragraph mentioning Podman as an alternative to Docker,
as users of Podman should already be aware of this, and it keeps the
docs cleaner.
@tomasfarias
Copy link
Contributor Author

Just to note: The reason I made the swap from docker to podman originally was because they introduced a new service agreement last year that made it impossible for me to use Docker Desktop at my previous company without a subscription (granted, I wasn't a user of Desktop specifically, but that's what introduced me to podman as an alternative):

Our Docker Subscription Service Agreement includes a change to the terms for Docker Desktop

  • It remains free for small businesses (fewer than 250 employees AND less than $10 million in annual revenue), personal use, education, and non-commercial open source projects.
  • It requires a paid subscription (Pro, Team or Business), for as little as $5 per user per month, for professional use in larger businesses.
  • The effective date of these terms is August 31, 2021. There is a grace period until January 31, 2022 for those that will require a paid subscription to use Docker Desktop.

I'm still not familiar enough with PostHog to understand if we could run into issues with the service agreement further down the line. But I imagine it's likely that this handbook page will need a more thorough refresh when/if that happens.

Copy link
Member

@Twixes Twixes left a comment

Choose a reason for hiding this comment

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

👌

@Twixes Twixes merged commit 14c64a8 into master Jan 3, 2023
@Twixes Twixes deleted the docs/update-develop-locally branch January 3, 2023 13:05
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.

2 participants