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.

Sign up for GitHub

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

Jump to bottom

WIP: ✨ A yaml-based DSL for creating CRDs #350

Closed
wants to merge 2 commits into from
Closed

WIP: ✨ A yaml-based DSL for creating CRDs #350

wants to merge 2 commits into from

Conversation

justinsb
Copy link
Contributor

@justinsb justinsb commented Sep 5, 2023

Aiming to make it easier to create CRDs.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 5, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: justinsb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 5, 2023
apelisse
apelisse reviewed Sep 5, 2023
View reviewed changes
yamlcrd/pkg/parser/testdata/simple1/expected.yaml Outdated
@@ -0,0 +1,70 @@
XNamespace:
Copy link
Contributor

Choose a reason for hiding this comment

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

it's hard to compare input with output since none of your fields appear to be omitempty in the output.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point! And fixed - I was importing the wrong yaml library (yaml.v3 instead of sigs.k8s.io/yaml)

apelisse
apelisse reviewed Sep 5, 2023
View reviewed changes
yamlcrd/pkg/parser/testdata/simple1/input.yaml Outdated
@@ -0,0 +1,22 @@
XNamespace:
Copy link
Contributor

Choose a reason for hiding this comment

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

is this example using all the features you've implemented? I'm curious how some of the complicated corner-cases are going to turn out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So there's definitely some major cheating going on right now, things like map(key=string,value=string) and int(min=0) are hard-coded so we can iterate on the syntax before committing to it.

Are there any particular corner scenarios you have in mind?

apelisse
apelisse reviewed Sep 5, 2023
View reviewed changes
yamlcrd/pkg/parser/testdata/simple1/input.yaml Outdated
# maxReplicas is the maximum number of replicas
maxReplicas: int(min=0)

containers:
Copy link
Contributor

Choose a reason for hiding this comment

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

For example, that list should have a listMap or whatever, right?

apelisse
apelisse reviewed Sep 5, 2023
View reviewed changes
yamlcrd/pkg/parser/testdata/simple1/input.yaml
minReplicas: int(min=0)

# maxReplicas is the maximum number of replicas
maxReplicas: int(min=0)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm assuming the int(min=0) language is entirely made-up? What are some of the principles behind it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Inspired by your kabstract python syntax. I think that named parameters are much better than positional ones here. We don't have anything particularly relevant in yaml. I guess that maybe we could do something like int{ min: 0 } but I think that might actually interact relatively poorly with yaml - I'm trying to do things that aren't too painful with yaml escaping rules etc.

I guess one big question is what about string values, how will quoting work there - I guess I'll try adding a string or two :-)

@justinsb
WIP: A yaml-based DSL for creating CRDs
16c8706 
Aiming to make it easier to create CRDs.
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 8, 2023
@justinsb
Copy link
Contributor Author

justinsb commented Sep 8, 2023

Wrote a (slightly) better parsing function for arguments, and also implemented a few more trickier annotations:

    containers(map-key=name):
    - name: string # The identifier for this container
      image: string(regex="image.*") # The container image to run

I don't love the placement of the map-key, but it does show that we can put parameters on keys without any real problem from the yaml parser.

@justinsb justinsb changed the title WIP: A yaml-based DSL for creating CRDs WIP: ✨ A yaml-based DSL for creating CRDs Sep 11, 2023
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 21, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 20, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apelisse apelisse apelisse left review comments

@atoato88 atoato88 Awaiting requested review from atoato88

@johnsonj johnsonj Awaiting requested review from johnsonj

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@justinsb @k8s-ci-robot @k8s-triage-robot @apelisse