weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #5497 from SgtCoDFish/nodevelreadme

Browse Source 
Update devel/README.md to recommend make instead
This commit is contained in:
jetstack-bot 2022-10-07 17:09:17 +01:00 committed by GitHub
commit 5f91c317e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
devel/README.md
View File

@ -1,100 +1,7 @@
# Development tooling
# Legacy Development Tooling
This directory contains tools and scripts used to create development and
testing environments for cert-manager.
These scripts are no longer maintained and shouldn't be used.
## Tool dependencies
If you want to build or develop cert-manager, use the documentation on [cert-manager.io](https://cert-manager.io/docs/contributing/building/).
The scripts in this directory commonly require additional tooling, such as
access to `kubectl`, `helm`, `kind` and a bunch of other things.
If you already have these tools available on your host system, the scripts
should just work, so long as the versions you have installed are roughly
compatible.
If you are running into issues with your host-installed tools, Bazel provides
versioned access to all of the required tools for the e3e scripts.
To setup your shell to use the Bazel provided versions of these tools, run the
following from the **root of the repository**:
```console
export PATH="$(pwd)/devel/bin:$PATH"
```
## Common usages
This section describes common usage patterns for development and testing.
### Creating a kind cluster
To create a kind cluster that can be used for both development and testing, run
`./devel/cluster/create.sh` from the root of the cert-manager repository:
```console
./devel/cluster/create.sh
```
You can change the name of the kind cluster created by setting:
```console
export KIND_CLUSTER_NAME=custom-cluster-name
```
If a cluster with the same name already exists, it will **not** be recreated
and instead will be reused.
### Installing a development build of cert-manager
Once you have a kind cluster running, you can install a development version of
cert-manager by running:
```console
./devel/addon/certmanager/install.sh
```
This will build, load and install cert-manager from source into your kind
development cluster.
Further invocations of the `install.sh` script will rebuild and upgrade the
installed version of cert-manager, making it possible to iteratively work on
the codebase and test changes.
### Running end-to-end tests
Before running the end-to-end tests, you must install some additional
components used during the tests into your kind cluster.
Run the following to setup persistent test instances of Pebble, ingress-nginx,
and a sample DNS01 webhook:
```console
./devel/setup-e2e-deps.sh
```
You only need to run this command once for the lifetime of your test cluster.
If you haven't already, deploy a new test build of cert-manager:
```console
./devel/addon/certmanager/install.sh
```
Finally, run the end-to-test tests using:
```console
./devel/run-e2e.sh
```
You can run this command multiple times against the same cluster without
adverse effects.
### Deleting the test cluster
Once you have finished with your testing environment, or if you have
encountered a strange state you cannot recover from, you can tear down the
testing environment by using `kind` directly:
```console
kind delete cluster [--name=$KIND_CLUSTER_NAME]
```
Those docs will walk through using make to develop cert-manager, which is the only officially tested and supported way.