Skip to content

Commit 67c798a

Browse files
authored
📖 docs(cert-manager): Change ownership links (#3610)
📖 docs(cert-manager): Change ownership links (#3610)
1 parent 5f75978 commit 67c798a

File tree

5 files changed

+31
-31
lines changed

5 files changed

+31
-31
lines changed

docs/book/src/cronjob-tutorial/cert-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deploying cert-manager
22

3-
We suggest using [cert-manager](https://github.com/jetstack/cert-manager) for
3+
We suggest using [cert-manager](https://github.com/cert-manager/cert-manager) for
44
provisioning the certificates for the webhook server. Other solutions should
55
also work as long as they put the certificates in the desired location.
66

docs/book/src/migration/legacy/v1vsv2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ information.
3131
- Automatic certificate generation for webhooks has been removed, and webhooks
3232
will no longer self-register. Use controller-tools to generate a webhook
3333
configuration. If you need certificate generation, we recommend using
34-
[cert-manager](https://github.com/jetstack/cert-manager). Kubebuilder v2 will
34+
[cert-manager](https://github.com/cert-manager/cert-manager). Kubebuilder v2 will
3535
scaffold out cert manager configs for you to use -- see the
3636
[Webhook Tutorial](/cronjob-tutorial/webhook-implementation.md) for more details.
3737

docs/book/src/multiversion-tutorial/deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ You'll need [cert-manager](../cronjob-tutorial/cert-manager.md) installed
3434
(version `0.9.0+`) unless you've got some other certificate management
3535
solution. The Kubebuilder team has tested the instructions in this tutorial
3636
with
37-
[0.9.0-alpha.0](https://github.com/jetstack/cert-manager/releases/tag/v0.9.0-alpha.0)
37+
[0.9.0-alpha.0](https://github.com/cert-manager/cert-manager/releases/tag/v0.9.0-alpha.0)
3838
release.
3939

4040
Once all our ducks are in a row with certificates, we can run `make

docs/book/src/reference/envtest.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
# Configuring envtest for integration tests
22

3-
The [`controller-runtime/pkg/envtest`][envtest] Go library helps write integration tests for your controllers by setting up and starting an instance of etcd and the
3+
The [`controller-runtime/pkg/envtest`][envtest] Go library helps write integration tests for your controllers by setting up and starting an instance of etcd and the
44
Kubernetes API server, without kubelet, controller-manager or other components.
55

66
## Installation
77

88
Installing the binaries is as a simple as running `make envtest`. `envtest` will download the Kubernetes API server binaries to the `bin/` folder in your project
9-
by default. `make test` is the one-stop shop for downloading the binaries, setting up the test environment, and running the tests.
9+
by default. `make test` is the one-stop shop for downloading the binaries, setting up the test environment, and running the tests.
1010

11-
The make targets require `bash` to run.
11+
The make targets require `bash` to run.
1212

1313
## Installation in Air Gapped/disconnected environments
14-
If you would like to download the tarball containing the binaries, to use in a disconnected environment you can use
15-
[`setup-envtest`][setup-envtest] to download the required binaries locally. There are a lot of ways to configure `setup-envtest` to avoid talking to
16-
the internet you can read about them [here](https://github.com/kubernetes-sigs/controller-runtime/tree/master/tools/setup-envtest#what-if-i-dont-want-to-talk-to-the-internet).
17-
The examples below will show how to install the Kubernetes API binaries using mostly defaults set by `setup-envtest`.
14+
If you would like to download the tarball containing the binaries, to use in a disconnected environment you can use
15+
[`setup-envtest`][setup-envtest] to download the required binaries locally. There are a lot of ways to configure `setup-envtest` to avoid talking to
16+
the internet you can read about them [here](https://github.com/kubernetes-sigs/controller-runtime/tree/master/tools/setup-envtest#what-if-i-dont-want-to-talk-to-the-internet).
17+
The examples below will show how to install the Kubernetes API binaries using mostly defaults set by `setup-envtest`.
1818

1919
### Download the binaries
20-
`make envtest` will download the `setup-envtest` binary to `./bin/`.
20+
`make envtest` will download the `setup-envtest` binary to `./bin/`.
2121
```shell
2222
make envtest
2323
```
2424

25-
Installing the binaries using `setup-envtest` stores the binary in OS specific locations, you can read more about them
25+
Installing the binaries using `setup-envtest` stores the binary in OS specific locations, you can read more about them
2626
[here](https://github.com/kubernetes-sigs/controller-runtime/tree/master/tools/setup-envtest#where-does-it-put-all-those-binaries)
2727
```sh
2828
./bin/setup-envtest use 1.21.2
2929
```
3030

3131
### Update the test make target
3232
Once these binaries are installed, change the `test` make target to include a `-i` like below. `-i` will only check for locally installed
33-
binaries and not reach out to remote resources. You could also set the `ENVTEST_INSTALLED_ONLY` env variable.
33+
binaries and not reach out to remote resources. You could also set the `ENVTEST_INSTALLED_ONLY` env variable.
3434

3535
```makefile
3636
test: manifests generate fmt vet
@@ -91,7 +91,7 @@ Controller-runtime’s [envtest][envtest] framework requires `kubectl`, `kube-ap
9191
9292
The `make test` command will install these binaries to the `bin/` directory and use them when running tests that use `envtest`.
9393
Ie,
94-
```shell
94+
```shell
9595
./bin/k8s/
9696
└── 1.25.0-darwin-amd64
9797
├── etcd
@@ -125,7 +125,7 @@ var _ = BeforeSuite(func(done Done) {
125125
126126
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
127127
testenv = &envtest.Environment{}
128-
128+
129129
_, err := testenv.Start()
130130
Expect(err).NotTo(HaveOccurred())
131131
@@ -213,25 +213,25 @@ For further information see the issue raised in the controller-runtime [controll
213213
214214
Projects scaffolded with Kubebuilder can enable the [`metrics`][metrics] and the [`cert-manager`][cert-manager] options. Note that when we are using the ENV TEST we are looking to test the controllers and their reconciliation. It is considered an integrated test because the ENV TEST API will do the test against a cluster and because of this the binaries are downloaded and used to configure its pre-requirements, however, its purpose is mainly to `unit` test the controllers.
215215
216-
Therefore, to test a reconciliation in common cases you do not need to care about these options. However, if you would like to do tests with the Prometheus and the Cert-manager installed you can add the required steps to install them before running the tests.
216+
Therefore, to test a reconciliation in common cases you do not need to care about these options. However, if you would like to do tests with the Prometheus and the Cert-manager installed you can add the required steps to install them before running the tests.
217217
Following an example.
218218
219219
```go
220-
// Add the operations to install the Prometheus operator and the cert-manager
221-
// before the tests.
220+
// Add the operations to install the Prometheus operator and the cert-manager
221+
// before the tests.
222222
BeforeEach(func() {
223223
By("installing prometheus operator")
224224
Expect(utils.InstallPrometheusOperator()).To(Succeed())
225-
225+
226226
By("installing the cert-manager")
227227
Expect(utils.InstallCertManager()).To(Succeed())
228228
}
229-
229+
230230
// You can also remove them after the tests::
231231
AfterEach(func() {
232232
By("uninstalling the Prometheus manager bundle")
233233
utils.UninstallPrometheusOperManager()
234-
234+
235235
By("uninstalling the cert-manager bundle")
236236
utils.UninstallCertManager()
237237
})
@@ -244,7 +244,7 @@ const (
244244
prometheusOperatorVersion = "0.51"
245245
prometheusOperatorURL = "https://raw.githubusercontent.com/prometheus-operator/" + "prometheus-operator/release-%s/bundle.yaml"
246246
certmanagerVersion = "v1.5.3"
247-
certmanagerURLTmpl = "https://github.com/jetstack/cert-manager/releases/download/%s/cert-manager.yaml"
247+
certmanagerURLTmpl = "https://github.com/cert-manager/cert-manager/releases/download/%s/cert-manager.yaml"
248248
)
249249
250250
func warnError(err error) {
@@ -284,14 +284,14 @@ func InstallCertManager() error {
284284
if _, err := Run(cmd); err != nil {
285285
return err
286286
}
287-
// Wait for cert-manager-webhook to be ready, which can take time if cert-manager
288-
//was re-installed after uninstalling on a cluster.
289-
cmd = exec.Command("kubectl", "wait", "deployment.apps/cert-manager-webhook",
290-
"--for", "condition=Available",
291-
"--namespace", "cert-manager",
292-
"--timeout", "5m",
287+
// Wait for cert-manager-webhook to be ready, which can take time if cert-manager
288+
//was re-installed after uninstalling on a cluster.
289+
cmd = exec.Command("kubectl", "wait", "deployment.apps/cert-manager-webhook",
290+
"--for", "condition=Available",
291+
"--namespace", "cert-manager",
292+
"--timeout", "5m",
293293
)
294-
294+
295295
_, err := Run(cmd)
296296
return err
297297
}
@@ -302,7 +302,7 @@ func LoadImageToKindClusterWithName(name string) error {
302302
if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
303303
cluster = v
304304
}
305-
305+
306306
kindOptions := []string{"load", "docker-image", name, "--name", cluster}
307307
cmd := exec.Command("kind", kindOptions...)
308308
_, err := Run(cmd)

test/e2e/utils/test_context.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import (
3232

3333
const (
3434
certmanagerVersion = "v1.5.3"
35-
certmanagerURLTmpl = "https://github.com/jetstack/cert-manager/releases/download/%s/cert-manager.yaml"
35+
certmanagerURLTmpl = "https://github.com/cert-manager/cert-manager/releases/download/%s/cert-manager.yaml"
3636
prometheusOperatorVersion = "0.51"
3737
prometheusOperatorURL = "https://raw.githubusercontent.com/prometheus-operator/" +
3838
"prometheus-operator/release-%s/bundle.yaml"

0 commit comments

Comments
 (0)