Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/self-host: add k8s requirements & other fixes #2222
docs/self-host: add k8s requirements & other fixes #2222
Changes from 1 commit
2fdfe23
d59685d
3fa2dd3
2742c4f
ddd9e62
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are missing the part about how to get the expandable volume. This should be documented to make users life easier (& we should test that we can make this work).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we shouldn't follow the route to copy and paste volume type specific how-to-steps from 3rd party documentations as they'll be likely out of date the second after we merge this PR.
Those are the volume types currently supported:
gcePersistentDisk
awsElasticBlockStore
Cinder
glusterfs
rbd
Azure File
Azure Disk
Portworx
FlexVolume
CSI
should we document and keep up to date the procedures on how to enable the setting for all of them?
I think it’s important to note that for PostHog we recommend the use of storage classes with expandable volumes, but then it’s up to our users to decide if and how they want to implement that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the same spirit as the suggestion for users to use DO. We want to avoid making it seem complicated to get PostHog up and running, if someone knows what they are doing they will do it anyway.
So in that spirit I do think it's worth it for us to document this explicitly for each platform, but we don't have to copy their documentation, we can just link to the right place similarly as we did for cluster creation. That yes will get out of date potentially and a user will ask about it in users slack & then we'll update it.
Btw one of our goals is to minimize the amount of time it takes for someone to spin up & maintain their self-hosted instance (we don't have metrics for this yet defined, but <10min average install time ; <15min average monthly maintenance time seem like good goals).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds like it could be a separate PR to outline the
Volumes
we support with documentation.The only
Volume
types I would support here aregcePersistentDisk
awsElasticBlockStore
Azure Disk
Anything beyond these and the user is using a stack that is going to be pretty custom.
Let's land this PR and add a todo to document these. No reason to hold up shipping this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same how can we get a qualifying cluster, is following the instructions good enough or not. cc @fuziontech to setup Azure account for PostHog team
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's your suggestion on this? Should we add more documentation on top of the official Azure documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My suggestion very specifically is for every platform specific guide:
Additionally in the "other platforms" I'd call out that this is something they'd want to check explicitly as many platforms default is non-expandable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's simply state that for all platforms outside DigitalOcean you must ensure that Kubernetes supports expandable volumes. We only have so many resources to spend on documentation here and the only platform I think we can all agree that should be as turn key as possible is DigitalOcean. The rest you are going to need to have some sort of understanding of what is going on in the K8s infrastructure or you will have a bad time.
Options for deploying PostHog sorted by how K8s familiar you are:
-----Should have baseline understanding of K8s beyond here-----
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the best way to spin up PostHog & I use this command all the time. If someone is using digital-ocean already this is great, I'd propose we don't remove it. It's also especially great as it sets up your kubectl to point to the cluster too. That said it's going to be less commonly used so we can put it into a details box and hide by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The note about http only applies for when we haven't enabled TLS, so we should move that up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
http part drop completely here as we didn't really provide an option for an unsecure instance. But add it to the "I cannot connect to my PostHog instance after creation" section as it's relevant there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as AWS & Azure - do we get the expanding volumes by default and if not how can we?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Plus it might be nice to mention in the DigitalOcean doc that we get that by default, so folks don't need to go investigate it. Note that we can document how to get expandable volumes for all of them in follow-up PRs.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need to get the URL here & I don't think this does that, but if nothing else the variable name is confusing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which URL? This command will output something like:
Except for the output format I didn't change variable names or anything from the previous version. What do you mean "we need to get the URL here"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If they already setup TLS they should access posthog via the hostname, not IP, e.g.
http://app.posthog.com
instead ofhttp://104.22.58.181
. Especially because it's possible to forbid direct IP accessThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So there's two different things: and separately: access your PostHog instance if TLS was set up, where arguably we can just say navigate to your hostname
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 but for what I saw we never rendered the hostname, even before this PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would be a nice to have - definitely not a blocker for getting this PR in
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sort alphabetically
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We actually sorted them that way on purpose. DigitalOcean is easiest to get started with and most transparent about pricing, but maybe we should explicitly say this here instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this could be subjective and not objective. Is it possible that our users find the pricing and setup of Azure or Oracle Cloud easier than DigitalOcean (maybe because they are already familiar with the platform).
I’m inclined to keep our docs as impartial as possible if you agree.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see https://posthog.slack.com/archives/C01MM7VT7MG/p1634231347133800