cc46849212
* Implement CodecFactoryOptions allowing clients to opt-in to Pretty encoders and Strict Decoders This patch introduces a new CodecFactory constructor that's capable of building different collections of Serializers. Note that this diverges from the current design where an initialized CodecFactory is a kitchen sink holding many forms of useful Serilaizers in a non-customizeable way. This approach is a suggested solution from this thread: https://groups.google.com/d/msg/kubernetes-sig-api-machinery/R4Iiz3rOYd0/O6aX15_AAQAJ A universal, defaulting, strict decoder is needed for Component Config efforts. Future work aims to make strict behavior the default -- right now it's not implemented in a way that is performant enough for the apiserver. This patch adds a deprecation notice for `NewCodecFactory()`. For now, uses of this public constructor remain unchanged, and the tests are still exercising it. It's been modified, however, to simply wrap the `WithOptions` version. * Extend NewCodecFactory() signature with options mutators When no mutators are passed, the legacy behavior is implemented. This allows code to continue using NewCodecFactory() without modifications. This also reverts the deprecation notice from the previous commit. * Make Pretty always default and remove public WithOptions constructor * Reduce []serializerType{} patch * Test Strict CodecFactory option when enabled/disabled * Fix CodecFactoryOptions nits
External Repository Staging Area
This directory is the staging area for packages that have been split to their own repository. The content here will be periodically published to respective top-level k8s.io repositories.
Repositories currently staged here:
k8s.io/apik8s.io/apiextensions-apiserverk8s.io/apimachineryk8s.io/apiserverk8s.io/cli-runtimek8s.io/client-gok8s.io/cloud-providerk8s.io/cluster-bootstrapk8s.io/code-generatork8s.io/component-basek8s.io/cri-apik8s.io/csi-apik8s.io/csi-translation-libk8s.io/kube-aggregatork8s.io/kube-controller-managerk8s.io/kube-proxyk8s.io/kube-schedulerk8s.io/kubectlk8s.io/kubeletk8s.io/legacy-cloud-providersk8s.io/metricsk8s.io/node-apik8s.io/sample-apiserverk8s.io/sample-cli-plugink8s.io/sample-controller
The code in the staging/ directory is authoritative, i.e. the only copy of the code. You can directly modify such code.
Using staged repositories from Kubernetes code
Kubernetes code uses the repositories in this directory via symlinks in the
vendor/k8s.io directory into this staging area. For example, when
Kubernetes code imports a package from the k8s.io/client-go repository, that
import is resolved to staging/src/k8s.io/client-go relative to the project
root:
// pkg/example/some_code.go
package example
import (
"k8s.io/client-go/dynamic" // resolves to staging/src/k8s.io/client-go/dynamic
)
Once the change-over to external repositories is complete, these repositories
will actually be vendored from k8s.io/<package-name>.
Creating a new repository in staging
Adding the staging repository in kubernetes/kubernetes:
-
Send an email to the SIG Architecture mailing list and the mailing list of the SIG which would own the repo requesting approval for creating the staging repository.
-
Once approval has been granted, create the new staging repository.
-
Add a symlink to the staging repo in
vendor/k8s.io. -
Update
import-restrictions.yamlto add the list of other staging repos that this new repo can import. -
Add all mandatory template files to the staging repo as mentioned in https://github.com/kubernetes/kubernetes-template-project.
-
Make sure that the
.github/PULL_REQUEST_TEMPLATE.mdandCONTRIBUTING.mdfiles mention that PRs are not directly accepted to the repo.
Creating the published repository
-
Create an issue in the
kubernetes/orgrepo to request creation of the respective published repository in the Kubernetes org. The published repository must have an initial empty commit. It also needs specific access rules and branch settings. See #kubernetes/org#58 for an example. -
Setup branch protection and enable access to the
stage-botsteam by adding the repo inprow/config.yaml. See #kubernetes/test-infra#9292 for an example. -
Once the repository has been created in the Kubernetes org, update the publishing-bot to publish the staging repository by updating:
-
rules.yaml: Make sure that the list of dependencies reflects the staging repos in theGodeps.jsonfile. -
fetch-all-latest-and-push.sh: Add the staging repo in the list of repos to be published.
-
-
Add the staging and published repositories as a subproject for the SIG that owns the repos in
sigs.yaml. -
Add the repo to the list of staging repos in this
README.mdfile.