Add ARCHITECTURE.md #3924

monopole · 2021-05-25T21:44:53Z

No description provided.

k8s-ci-robot · 2021-05-25T21:44:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: monopole

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:

~~OWNERS~~ [monopole]

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

ARCHITECTURE.md

KnVerey · 2021-06-15T16:04:07Z

ARCHITECTURE.md

+ |     `kyaml` | The [`kyaml`] module, holding Kubernetes-specific YAML editing packages used by the [`api`] module. |
+ |    `plugin` | Examples of Kustomize plugins.  |
+ | `releasing` | Instructions for releasing the various modules.  |
+ |      `site` | Old generated documentation, kept to provide redirection links to the new docs. |


How long do we need to keep this (and docs/) for? In what cases were things linking to the markdown source for the content rather than the live site itself?

(i'm prepping a pr)

KnVerey · 2021-06-15T16:10:25Z

ARCHITECTURE.md

+[semantically versioned]: https://semver.org
+[Go modules]: https://github.com/golang/go/wiki/Modules
+
+The [Go modules] in the kustomize repository are [semantically versioned].


It could be helpful to mention any guidance around intra-repo module dependencies. E.g. it came up recently that having two mutually dependent modules, though possible if triggered by different packages, would throw a wrench in the release process.

The first line in each module section specifies the intra-module dependence.
I added a bullet and some italics to spring them out more.

Yes, I see that, and it's great, but what I was hoping for was something more prescriptive than descriptive. i.e. kyaml not only doesn't have internal deps, but MUST NOT have any internal deps, and why.

Incidentally, more guidance on external dependencies would be great. E.g. be SUPER hesitant to add new ones, check licences, and absolutely never add X because of Y aspect of the kubectl integration.

KnVerey · 2021-06-15T16:19:29Z

ARCHITECTURE.md

+
+    - Optional  `legacy` reordering of objects, overriding
+      a FIFO rule.
+    - Optional addition of _Managed by kustomize_ annotations.


What governs that annotation? I know the above is a flag we have plans to turn into a field, but I wasn't aware of this setting.

There is a flag for this too, kustomize build --enable-managedby-label.

I think it sets a label, not an annotation.

Interesting. On the one hand, that also is violating the no-side-effects-from-flags thing, so maybe we should deprecate it on the same grounds as --reorder. But this one can already be done with common[Annotations/Labels] so I wonder in what cases the flag is used. E.g. maybe for enforcement?

Rewrote this to answer those questions.

Agree it should be controlled by a kustomization file field, not a flag, though in this particular case, the side-effect is only the addition of annotations so cluster behavior not impacted. Natasha is providing the mechanism for this in #4065

natasha41575 · 2021-06-15T20:35:57Z

ARCHITECTURE.md

+    E.g. if a ConfigMaps was given a generated name, all objects that
+    refer to that ConfigMap must be given it's name.
+
+  - Resolve vars, replacing them with whatever they refer to (a legacy feature).


How long are we planning to keep in the vars code for?

My guess is that it's not so much a matter of time passing as a matter of preparedness to cut major versions. E.g. the vars code needs to go before we can release v1.0 of the API module, but after we release v5 of the CLI.

Why does it need to happen after we release v5 of the CLI?

Sorry, I meant as part of the v5 release

k8s-triage-robot · 2021-10-24T21:31:47Z

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

This bot triages issues and 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 issue is closed

You can:

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

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

/lifecycle stale

k8s-triage-robot · 2021-11-23T22:12:30Z

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

This bot triages issues and 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 issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or 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 · 2021-12-22T19:26:24Z

@monopole: 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.

KnVerey · 2021-12-22T19:26:55Z

/lgtm

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 May 25, 2021

k8s-ci-robot requested review from pwittrock and Shell32-Natsu May 25, 2021 21:44

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 25, 2021

monopole requested review from KnVerey and removed request for Shell32-Natsu and pwittrock May 25, 2021 21:45

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 25, 2021

natasha41575 reviewed May 26, 2021

View reviewed changes

ARCHITECTURE.md Show resolved Hide resolved

KnVerey reviewed Jun 15, 2021

View reviewed changes

natasha41575 reviewed Jun 15, 2021

View reviewed changes

monopole force-pushed the architecture branch 3 times, most recently from 8247d95 to 24e3f2f Compare July 25, 2021 14:39

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 25, 2021

monopole force-pushed the architecture branch from 24e3f2f to f78b0ab Compare July 25, 2021 14:42

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 25, 2021

monopole force-pushed the architecture branch 8 times, most recently from ce7e567 to d72f57f Compare July 25, 2021 15:59

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 24, 2021

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 Nov 23, 2021

monopole and others added 2 commits December 22, 2021 12:07

Add ARCHITECTURE.md

2a608bd

Minor updates and clarifications

56efec5

KnVerey force-pushed the architecture branch from d72f57f to 56efec5 Compare December 22, 2021 19:26

k8s-ci-robot assigned KnVerey Dec 22, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 22, 2021

KnVerey changed the title ~~WIP: Add ARCHITECTURE.md~~ Add ARCHITECTURE.md Dec 22, 2021

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 22, 2021

k8s-ci-robot merged commit 3608f33 into kubernetes-sigs:master Dec 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ARCHITECTURE.md #3924

Add ARCHITECTURE.md #3924

monopole commented May 25, 2021

k8s-ci-robot commented May 25, 2021

KnVerey Jun 15, 2021

monopole Jul 25, 2021

monopole Jul 25, 2021

KnVerey Jun 15, 2021

monopole Jul 25, 2021

KnVerey Jul 26, 2021

KnVerey Jun 15, 2021

natasha41575 Jun 15, 2021 •

edited

Loading

KnVerey Jun 15, 2021

monopole Jul 25, 2021

natasha41575 Jun 15, 2021

KnVerey Jun 15, 2021

natasha41575 Jun 23, 2021

KnVerey Jun 23, 2021

k8s-triage-robot commented Oct 24, 2021

k8s-triage-robot commented Nov 23, 2021

k8s-ci-robot commented Dec 22, 2021

KnVerey commented Dec 22, 2021

Add ARCHITECTURE.md #3924

Add ARCHITECTURE.md #3924

Conversation

monopole commented May 25, 2021

k8s-ci-robot commented May 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natasha41575 Jun 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-triage-robot commented Oct 24, 2021

k8s-triage-robot commented Nov 23, 2021

k8s-ci-robot commented Dec 22, 2021

KnVerey commented Dec 22, 2021

natasha41575 Jun 15, 2021 •

edited

Loading