-
Notifications
You must be signed in to change notification settings - Fork 102
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.
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
Change master to main #1565
Change master to main #1565
Conversation
Signed-off-by: Gerred Dillon <hello@gerred.org>
2375e20
to
2ceb89e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- it seems like
.github/workflows/release-on-master.yml
file should be renamed - there are a number links to site we don't control that we can't change
- there are changes to kubebuilder/operator repo which are fine... but needs operator repo to follow suit
- there is a commit that needs refactoring
keps/0008-operator-testing.md
Outdated
@@ -363,7 +363,7 @@ In order for a test case to be considered successful, all resources created by i | |||
* Integration into KUDO Operators's pull request pipeline. | |||
* Integration into KUDO's pull request pipeline. | |||
* CLI for running tests. | |||
* Plugin for [Sonobuoy](https://github.com/heptio/sonobuoy/blob/master/docs/plugins.md) available. | |||
* Plugin for [Sonobuoy](https://github.com/heptio/sonobuoy/blob/main/docs/plugins.md) available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
keps/0008-operator-testing.md
Outdated
@@ -377,15 +377,15 @@ Controllers are typically tested using test libraries in the same language that | |||
* [Kubernetes e2e test operator](https://godoc.org/k8s.io/kubernetes/test/e2e/operator) provides a methods that interact with Kubernetes resources and wait for certain Kubernetes state. It also supports conditionally running tests and collecting logs and results from pods and nodes. | |||
* Unit tests can be written using the [Kubernetes fake clientset](https://godoc.org/k8s.io/client-go/kubernetes/fake) without needing a Kubernetes API at all - allowing easy testing of expected state transitions in a controller. | |||
* The [controller-runtime](https://godoc.org/sigs.k8s.io/controller-runtime/pkg) provides test machinery that makes it easy to integration test controllers without a running Kubernetes cluster. The KUDO project itself uses these extensively. | |||
* The [Kubernetes command-line integration test suite](https://github.com/kubernetes/kubernetes/tree/master/test/cmd) is a BASH-driven integration test suite that uses kubectl commands to run tests. This could be a suitable option as it is not a specialized programming language, but it is an imperative method of testing which may not be the right UX for KUDO. | |||
* The [Kubernetes command-line integration test suite](https://github.com/kubernetes/kubernetes/tree/main/test/cmd) is a BASH-driven integration test suite that uses kubectl commands to run tests. This could be a suitable option as it is not a specialized programming language, but it is an imperative method of testing which may not be the right UX for KUDO. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
keps/0008-operator-testing.md
Outdated
* [Terratest](https://godoc.org/github.com/gruntwork-io/terratest/modules/k8s) is a Go-based testing harness that provides methods for interacting with Kubernetes resources and waiting for them to be ready. | ||
* [metacontroller](https://github.com/GoogleCloudPlatform/metacontroller/blob/master/examples/daemonjob/test.sh) does not provide a test harness out of the box, but many of their examples use a bash script with kubectl commands to compose simple tests. | ||
* [metacontroller](https://github.com/GoogleCloudPlatform/metacontroller/blob/main/examples/daemonjob/test.sh) does not provide a test harness out of the box, but many of their examples use a bash script with kubectl commands to compose simple tests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
keps/0008-operator-testing.md
Outdated
* [Terraform provider acceptance tests](https://www.terraform.io/docs/extend/testing/acceptance-tests/testcase.html) are authored by providing a series of configurations to apply with expected states and provided some inspiration for this design. | ||
|
||
[Helm charts](https://github.com/helm/helm/blob/master/docs/chart_tests.md) use a scheme for running tests where tests are defined as Kubernetes Jobs that are run and the result is determined by the Job status. This methodology is compatible with KUDO and can be seen applied in the Zookeeper Operator's [validation job](https://github.com/kudobuilder/operators/blob/2b1151eca761c0fbe61474ba44b0bdaa4f80a0fb/repo/stable/zookeeper/versions/0/zookeeper-operatorversion.yaml#L161-L188). This document does not supercede this technique (tests written for KUDO Operators can easily incorporate these validation stages), the machinery provided here will be able to easily incorporate these tests to improve test quality. | ||
[Helm charts](https://github.com/helm/helm/blob/main/docs/chart_tests.md) use a scheme for running tests where tests are defined as Kubernetes Jobs that are run and the result is determined by the Job status. This methodology is compatible with KUDO and can be seen applied in the Zookeeper Operator's [validation job](https://github.com/kudobuilder/operators/blob/2b1151eca761c0fbe61474ba44b0bdaa4f80a0fb/repo/stable/zookeeper/versions/0/zookeeper-operatorversion.yaml#L161-L188). This document does not supercede this technique (tests written for KUDO Operators can easily incorporate these validation stages), the machinery provided here will be able to easily incorporate these tests to improve test quality. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change helm
keps/0020-manual-plan-execution.md
Outdated
@@ -83,7 +83,7 @@ This also counts with the fact that on the server-side we have an admission webh | |||
|
|||
Although it’s very easy to do this, it’s not very Kubernetes idiomatic way of doing things especially because Status should never be updated from a client and it should just capture the state of the object. | |||
|
|||
For some background, including definition of status sub-resource by [API conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status): `The status summarizes the current state of the object in the system, and is usually persisted with the object by an automated processes but may be generated on the fly. At some cost and perhaps some temporary degradation in behavior, the status could be reconstructed by observation if it were lost.` | |||
For some background, including definition of status sub-resource by [API conventions](https://github.com/kubernetes/community/blob/main/contributors/devel/sig-architecture/api-conventions.md#spec-and-status): `The status summarizes the current state of the object in the system, and is usually persisted with the object by an automated processes but may be generated on the fly. At some cost and perhaps some temporary degradation in behavior, the status could be reconstructed by observation if it were lost.` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change k8s/community
pkg/kudoctl/cmd/repo_index.go
Outdated
@@ -151,7 +151,7 @@ func (ri *repoIndexCmd) run() error { | |||
} | |||
|
|||
func merge(index *repo.IndexFile, mergeIndex *repo.IndexFile) { | |||
// index is the master, any dups in the merged in index will have what is local replace those entries | |||
// index is the main, any dups in the merged in index will have what is local replace those entries |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm... not sure this makes sense... but I don't know the best solution... main
doesn't make sense. master here means master copy... after re-reading.. this comment is (likely written by me) and it not great :( AND it should be the line above func, not after.
// index is the reference copy which will have non-duplicated entries added to it from the mergedIndex
pkg/version/base.go
Outdated
@@ -14,10 +14,10 @@ package version | |||
|
|||
var ( | |||
// semantic version, derived by build scripts (see | |||
// https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md | |||
// https://github.com/kubernetes/community/blob/main/contributors/design-proposals/release/versioning.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
SECURITY_CONTACTS
Outdated
@@ -4,7 +4,7 @@ | |||
# to for triaging and handling of incoming issues. | |||
# | |||
# The below names agree to abide by the | |||
# [Embargo Policy](https://github.com/kubernetes/sig-release/blob/master/security-release-process-documentation/security-release-process.md#embargo-policy) | |||
# [Embargo Policy](https://github.com/kubernetes/sig-release/blob/main/security-release-process-documentation/security-release-process.md#embargo-policy) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
STYLEGUIDE.md
Outdated
@@ -69,4 +69,4 @@ Sorting type [gofmt] | |||
|
|||
### Naming | |||
|
|||
In general, naming should follow [Go conventions](https://golang.org/doc/effective_go.html#names) over [Kubernetes code conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md#code-conventions). | |||
In general, naming should follow [Go conventions](https://golang.org/doc/effective_go.html#names) over [Kubernetes code conventions](https://github.com/kubernetes/community/blob/main/contributors/guide/coding-conventions.md#code-conventions). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
hack/generate_krew.sh
Outdated
@@ -80,4 +80,4 @@ generate_platform darwin 386 ./kubectl-kudo >> kudo.yaml | |||
# generate_platform windows amd64 ./kubectl-kudo.exe >> kudo.yaml | |||
# generate_platform windows 386 ./kubectl-kudo.exe >> kudo.yaml | |||
|
|||
echo "To publish to the krew index, create a pull request to https://github.com/kubernetes-sigs/krew-index/tree/master/plugins to update kudo.yaml with the newly generated kudo.yaml." | |||
echo "To publish to the krew index, create a pull request to https://github.com/kubernetes-sigs/krew-index/tree/main/plugins to update kudo.yaml with the newly generated kudo.yaml." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can't change this
@kensipe nice catches I'll fix these, I did a wide search and replace as you can probably tell. Too many to accurately follow up on, thought some were referring to our docs. :) |
I needed to jump to some other work... but was planning on circling back to resolve these. IF you don't get to them... I'll get them.. no sure when yet. |
Signed-off-by: Ken Sipe <kensipe@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
No description provided.