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

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

Merged
merged 12 commits into from
Jul 26, 2024
Merged

Conversation

zerbitx
Copy link
Contributor

@zerbitx zerbitx commented Jul 16, 2024

Copy link

netlify bot commented Jul 16, 2024

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 19a1904
🔍 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...

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 zerbitx marked this pull request as draft July 16, 2024 12:25
@zerbitx
Copy link
Contributor Author

zerbitx commented Jul 16, 2024

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

@zerbitx
Copy link
Contributor Author

zerbitx commented Jul 16, 2024

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 zerbitx marked this pull request as ready for review July 16, 2024 20:09
@zerbitx zerbitx requested a review from deniseschannon July 16, 2024 20:09
@zerbitx zerbitx changed the title Adds external.platform.apiKey docs Adds external.platform.(apiKey/autoSleep/autoDelete) docs Jul 16, 2024
Copy link
Contributor

@rohantmp rohantmp left a comment

Choose a reason for hiding this comment

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

It's not obvious to me if fields like autoSleep and external are top level vcluster.yaml fields from this page: https://deploy-preview-194--vcluster-docs-site.netlify.app/docs/platform/api/resources/vcluster-yaml/

I know external is, so I assume autoSleep is too from the structure of the docs, but maybe we can add a comment on the vcluster.yaml page in platform to make this clearer?

@zerbitx
Copy link
Contributor Author

zerbitx commented Jul 17, 2024

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

@zerbitx zerbitx requested a review from rohantmp July 17, 2024 13:10
@deniseschannon
Copy link
Contributor

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

@zerbitx
Copy link
Contributor Author

zerbitx commented Jul 19, 2024

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

@deniseschannon
Copy link
Contributor

deniseschannon commented Jul 19, 2024

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:
Screenshot 2024-07-19 at 5 31 48 AM

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

Screenshot 2024-07-19 at 5 31 41 AM

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

@deniseschannon
Copy link
Contributor

deniseschannon commented Jul 19, 2024

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
Copy link
Contributor

deniseschannon commented Jul 19, 2024

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
Copy link
Contributor

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.

@zerbitx zerbitx marked this pull request as draft July 19, 2024 14:08
@zerbitx zerbitx marked this pull request as ready for review July 23, 2024 00:14
@deniseschannon
Copy link
Contributor

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

@deniseschannon deniseschannon merged commit 7b94c6c into main Jul 26, 2024
5 checks passed
@deniseschannon deniseschannon deleted the DOC-192 branch July 26, 2024 01:45
deniseschannon added a commit that referenced this pull request Jul 26, 2024
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.

3 participants