Adds external.platform.(apiKey/autoSleep/autoDelete) docs

zerbitx commented 2 months ago

Resolves DOC-192 and DOC-196

vCluster preview: https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/vcluster/configure/vcluster-yaml/ vCluster Platform preview: https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/platform/virtual-clusters/configure/vcluster-yaml/

netlify[bot] commented 2 months ago

Deploy Preview for vcluster-docs-site ready!

Name	Link
Latest commit	19a190436e6ad1e303f688baf360818b909abc15
Latest deploy log	https://app.netlify.com/sites/vcluster-docs-site/deploys/669ef97361067e0008c288c8
Deploy Preview	https://deploy-preview-194--vcluster-docs-site.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

zerbitx commented 2 months ago

Setting this as draft until the createRBAC apiKey changes are merged and I can update.

zerbitx commented 2 months ago

I talked with Russ and Denise and Denise about this one and where the platform config options should reside given that the vcluster.yaml docs are on the OSS side of the docs. The plan is to have the generator produce the partials in the regular location and only have it the platform specific fields show up in a new vcluster.yaml section on the platform side.

zerbitx commented 2 months ago

@rohantmp very good point. I've updated to build the partials for the hierarchy and put that at the top level

deniseschannon commented 2 months ago

Shouldn't there be updates on vcluster.yaml and the support in there? I don't see it in this PR.

zerbitx commented 2 months ago

@deniseschannon Added those to the vCluster side with pro labels.

deniseschannon commented 2 months ago

vcluster.yaml in vCluster Preview Comments

Based on the files, it looks like we're kind of autogenerating it, but I'm not sure.

The generated partials include information from the config file that describe the key.

Example:

Where as the current keys in the external field are all blank:

Can we add that info in for the external keys as well?

deniseschannon commented 2 months ago

vcluster.yaml in vCluster Preview Comments

The layout for the new pages look different than the older pages, where we generally have a small blurb about what the key is about. A simple explanation of how to use it. Then we have an example section and finally the config reference.

https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/vcluster/configure/vcluster-yaml/experimental/deny-proxy-requests

deniseschannon commented 2 months ago

vcluster.yaml in vCluster Preview Comments

Somehow we're missing pages for external and the platform levels. You can see in this page, how the toggle navbar is actually also a link.

It would be good for us to explain what anything under external means and what does platform. If you need help with that explanation, let me know.

https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/vcluster/configure/vcluster-yaml/sync/

deniseschannon commented 2 months ago

Platform Comments

I'm fine with adding this in resources, but also think we need somewhere in the Virtual Cluster section which describes how externally deployed vclusters could connect to the platform. Unfortunately, I haven't gotten around to adding in content about externally deployed vs. platform deployed. But if we add a new page for "Connecting to the Platform" that might be a good starting point.

deniseschannon commented 1 month ago

This is difficult for reviews, so I'll merge as is and update it afterwards.

loft-sh / vcluster-docs