Origin Kubernetes

This repo was previously the core Kubernetes tracking repo forOKD, and where OpenShift'shyperkube and openshift-test binaries were maintained. As of July2020, the purpose and maintenance strategy of the repo varies bybranch.

Maintenance of master and release-x.x branches for 4.6 and above

These branches no longer include the code required to producehyperkube binaries, and are limited to maintaining the openshift-testsbinary. Responsibility for maintaining hyperkube has transitioned tothe openshift/kubernetesrepo.

Backports and carries against upstream should be proposed toopenshift/kubernetes. If changes merged to openshift/kubernetesneed to land in origin, it will be necessary to follow up with a PRto origin that bumps the vendoring.

Branch names are correlated across the 2 repositories such thatchanges merged to a given branch in openshift/kubernetes should bevendored into the same branch in origin (e.g. master inopenshift/kubernetes is vendored into master in origin).

NOTE: Vendoring of the master and release-x.x branches ofopenshift/kubernetes into the equivalent branches in origin isintended to be temporary. At some point in the near future, originwill switch to vendoring origin-specific branches (e.gorigin-4.6-kubernetes-1.19.2) to minimize the scope of backports andcarries that need to be considered in the context ofopenshift/kubernetes rebases.

Test annotation rules

Test annotation rules are used to label e2e tests so that they can befiltered or skipped. For example, rules can be defined that match kubee2e tests that are known to be incompatible with openshift and labelthose tests to be skipped.

Maintenance of test annotation rules is split between theopenshift/kubernetes and origin repos to ensure that PRs proposedto openshift/kubernetes can be validated against the set of kube e2etests known to be compatible with openshift.

Test annotation rules for kubernetes e2e tests are maintained in:

https://github.com/openshift/kubernetes/blob/master/openshift-hack/e2e/annotate/rules.go

Test annotation rules for openshift e2e tests are maintained in:

https://github.com/openshift/origin/blob/master/test/extended/util/annotate/rules.go

Origin vendors the kube rules and applies both the kube and openshiftrules to the set of tests included in the openshift-tests binary.

In order to update test annotation rules for kube e2e tests, it willbe necessary to:

• Update rules.go in openshift/kubernetes
• Bump the version of openshift/kubernetes vendored in origin

Vendoring from openshift/kubernetes

These origin branches vendor k8s.io/kubernetes and some of itsstaging repos (e.g. k8s.io/api) from ouropenshift/kubernetes fork.Upstream staging repos are used where possible, but some tests dependson functionality that is only present in the fork.

When a change has merged to an openshift/kubernetes branch thatneeds to be vendored into the same branch in origin, thehack/update-kube-vendor.sh helper script simplifies updating the gomodule configuration for all dependencies sourced fromopenshift/kubernetes for that branch. The script requires either thename of a branch or a SHA from openshift/kubernetes:

$ hack/update-kube-vendor.sh <openshift/kubernetes branch name or SHA>

The script also supports performing a fake bump to validate an as-yetunmerged change to openshift/kubernetes. This can be accomplished bysupplying the name of a fork repo as the second argument to thescript:

$ hack/update-kube-vendor.sh <branch name or SHA> github.com/myname/kubernetes

Once the script has executed, the vendoring changes will need to becommitted and proposed to the repo.

Working around '410 Gone' error

If the script returns '410 Gone' as per the error that follows, it maybe that the golang checksum server does not yet know about the targetSHA.

go: k8s.io/kubernetes@v1.21.1 (replaced by github.com/openshift/kubernetes@v1.21.2-0.20210603185452-2dfc46b23003): verifying go.mod: g
ithub.com/openshift/kubernetes@v1.21.2-0.20210603185452-2dfc46b23003/go.mod: reading https://sum.golang.org/lookup/github.com/openshif
t/kubernetes@v1.21.2-0.20210603185452-2dfc46b23003: 410 Gone
        server response: not found:

The workaround is to set GOSUMDB=off to disable the checksumdatabase for the vendoring update:

$ GOSUMDB=off hack/update-kube-vendor.sh <branch name or SHA>

Maintenance of release-4.5, release-4.4 and release-4.3

Releases prior to 4.6 continue to maintain hyperkube in the originrepo in the release-4.x branches. Persistent carries and backportsfor those branches should continue to be submitted directly toorigin. openshift/kubernetes is not involved except for rebases.

End-to-End (e2e) and Extended Tests

End to end tests (e2e) should verify a long set of flows in theproduct as a user would see them. Two e2e tests should not overlapmore than 10% of function and are not intended to test errorconditions in detail. The project examples should be driven by e2etests. e2e tests can also test external components working together.

All e2e tests are compiled into the openshift-tests binary.To build the test binary, run make.

To run a specific test, or an entire suite of tests, readtest/extended/READMEfor more information.

Updating external examples

hack/update-external-example.sh will pull down example files from externalrepositories and deposit them under the examples directory.Run this script if you need to refresh an example file, or add a new one. Seethe script and examples/quickstarts/README.md for more details.