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(policy): automatically convert policy yaml #1290

Merged
merged 1 commit into from
Jun 15, 2023

Conversation

jakubdyszkiewicz
Copy link
Contributor

Add plugin to generate policy tabs for universal and kubernetes and automatically convert universal yaml to kubernetes yaml.

I changed only one file, but once this is merged I'll go over all occurrences in the project to clean it up.

The difference with MeshCircuitBreaker is that we are missing

We will apply the configuration with `kubectl apply -f [..]`.

and

We will apply the configuration with `kumactl apply -f [..]` or via the [HTTP API](/docs/{{ page.version }}/reference/http-api).

I don't find this useful, but I can also add this information to an HTML generated by the plugin. It can be even opt-in.

@jakubdyszkiewicz jakubdyszkiewicz requested review from a team, lobkovilya and lukidzi and removed request for a team April 6, 2023 15:25
@netlify
Copy link

netlify bot commented Apr 6, 2023

Deploy Preview for kuma ready!

Name Link
🔨 Latest commit 0678898
🔍 Latest deploy log https://app.netlify.com/sites/kuma/deploys/648b06d1f3733e0008162eff
😎 Deploy Preview https://deploy-preview-1290--kuma.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 settings.

@lahabana
Copy link
Contributor

lahabana commented Apr 6, 2023

@fabianrbz for this to be usable in both Kuma and Kong-Mesh we need to extract this in a gem?

@lahabana lahabana marked this pull request as draft April 12, 2023 14:20
@lahabana
Copy link
Contributor

Putting this as draft as we need to extract this to make it usable in both doc sites

@Automaat
Copy link
Contributor

I am missing one thing here. I think it is beneficial to have policies that have service names easily understandable on every platform. For example on universal you can set service name to any value like: demo-app, on k8s on the other hand service name contains namespace and port: demo-app_kuma-demo_svc_5000. It would be good to include it in this plugin somehow.

Another topic I think it would be also helpful for users to base all policies example on demo app, so they can simply play with them and apply them without changing anything.

@lahabana
Copy link
Contributor

I am missing one thing here. I think it is beneficial to have policies that have service names easily understandable on every platform. For example on universal you can set service name to any value like: demo-app, on k8s on the other hand service name contains namespace and port: demo-app_kuma-demo_svc_5000. It would be good to include it in this plugin somehow.

Makes sense my guess is that this could be done as a follow up

@michaelbeaumont
Copy link
Contributor

@jakubdyszkiewicz is this already working with the new reusable plugin stuff in #1303?

@jakubdyszkiewicz
Copy link
Contributor Author

@michaelbeaumont It doesn't. Is there a repo or something to this plugin to the gem?

@michaelbeaumont
Copy link
Contributor

@jakubdyszkiewicz It's in this repo, I think you just have to make changes similar to 46e2f01

@jakubdyszkiewicz
Copy link
Contributor Author

It seems it's there, Charly moved this around

@jakubdyszkiewicz jakubdyszkiewicz marked this pull request as ready for review June 15, 2023 12:27
Copy link
Contributor

@michaelbeaumont michaelbeaumont left a comment

Choose a reason for hiding this comment

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

Nice! LGTM

@jakubdyszkiewicz
Copy link
Contributor Author

created an issue for name conversion #1359

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.

6 participants