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

Add Generator Tasks to Documentation #5368

Merged
merged 34 commits into from
Oct 27, 2023
Merged

Add Generator Tasks to Documentation #5368

merged 34 commits into from
Oct 27, 2023

Conversation

ncapps
Copy link
Contributor

@ncapps ncapps commented Oct 10, 2023 •
edited
Loading

Add Generator Tasks per feedback from #5346

Related issue: #5286

@k8s-ci-robot
Copy link
Contributor

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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.

@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. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 10, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @ncapps. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 10, 2023
@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 Oct 10, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Oct 10, 2023

Hi @annasong20, I think adding the Examples to the Tasks section similar to the Kubernetes.io website makes a lot of sense. For the Kustomize Reference section, did we want to define a specification similar to the Kubernetes API section? Should I try to replicate something like the Pod specification for the configMapGenerator and secretGenerator?

@ncapps ncapps changed the title Docs/tasks generators Add Generator Tasks to Documentation Oct 10, 2023
@annasong20
Copy link
Contributor

For the Kustomize Reference section, did we want to define a specification similar to the Kubernetes API section? Should I try to replicate something like the Pod specification for the configMapGenerator and secretGenerator?

Yup, that's what I envisioned! Because this is technically out of the scope of #5286, I just created #5379 to track adding specifications to the Reference section. You can assign yourself if you plan to work on it. Also, you can make this change in a separate PR if you'd like, too. Your call.

Tagging @bugoverdose to ensure we're all on the same page, as he previously worked on the Reference section.

@annasong20
Copy link
Contributor

@ncapps From a quick scan, this PR looks great! FYI I think this issue also makes progress on #5352, which overlaps with #5286. Feel free to assign #5352 to yourself as well.

ncapps added a commit to ncapps/kustomize that referenced this pull request Oct 22, 2023
@ncapps
Update page weights per change in PR kubernetes-sigs#5368
a973291
annasong20
annasong20 approved these changes Oct 27, 2023
View reviewed changes
Copy link
Contributor

@annasong20 annasong20 left a comment

Choose a reason for hiding this comment

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

@ncapps Looks awesome!! Thank you so much for your continual work here! I have 1 small optional nit, so I'll approve and let you un-hold when you're ready.

/approve
/lgtm
/hold for Nick's discretion

site/content/en/docs/Tasks/configmap_generator.md
name: config-volume
```

[`configMapGenerator`]: /docs/reference/api/kustomization-file/configmapgenerator/
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

site/content/en/docs/Tasks/configmap_generator.md
name: my-application-properties-f7mm6mhf59
```

It is also possible to [define a key](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#define-the-key-to-use-when-creating-a-configmap-from-a-file) to set a name different than the filename.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

site/content/en/docs/Tasks/configmap_generator.md
SAMPLER_PARAMETERS: "0.1"
```

## Create ConfigMap with options
Copy link
Contributor

Choose a reason for hiding this comment

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

Beautiful!

site/content/en/docs/Tasks/secret_generator.md
2. Create a `credentials.txt` file.
```yaml
# credentials.txt
username=admin
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

site/content/en/docs/Tasks/secret_generator.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 27, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 27, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: annasong20, ncapps

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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 27, 2023
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 27, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Oct 27, 2023

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 27, 2023
@annasong20
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 27, 2023
@k8s-ci-robot k8s-ci-robot merged commit bd435d4 into kubernetes-sigs:master Oct 27, 2023
9 checks passed
@ncapps ncapps mentioned this pull request Nov 13, 2023
Closed
9 tasks
antoooks pushed a commit to antoooks/kustomize that referenced this pull request Nov 21, 2023
@ncapps @antoooks
Add Generator Tasks to Documentation (kubernetes-sigs#5368)
dc7255d 
* Update tasks index description

* Create generators folder

* Update tasks/generators titles

* Add rollouts placeholder

* Add generate configmap from file example

* Add literals and env file example

* Add propogation example

* Consistent punctuation

* Update grammar

* Clean up configmaps page

* Remove examples from configMapGenerator ref page

* Move secret examples to Tasks

* Clean up spacing

* Consolidate cm and secret

* Consistent grammar

* Cleanup

* Address feedback

* Bump date

* Fix propagate spelling

* Remove roll out updates section

* Separate configmap and secret generator tasks

* Add secret from file example

* Add secret from literals example

* Update tls secret example

* Update task page weights

* Link cm generator reference

* Add link to secret reference

* Remove secretGenerator example from reference section

* Add configmap options task, clean up reference

* Add file with key example

* Secrets are base64 encoded
@ncapps ncapps mentioned this pull request Dec 1, 2023
Merged
@ncapps ncapps deleted the docs/tasks-generators branch January 31, 2024 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@annasong20 annasong20 annasong20 approved these changes

@koba1t koba1t Awaiting requested review from koba1t

@yuwenma yuwenma Awaiting requested review from yuwenma

@bugoverdose bugoverdose Awaiting requested review from bugoverdose

Assignees

@annasong20 annasong20

@bugoverdose bugoverdose

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
Kustomize Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ncapps @k8s-ci-robot @annasong20 @natasha41575 @bugoverdose