Skip to content

Commit 01ac27d

Browse files
[VC-45018] Improve consistency of contextual information in cert-components (#739)
* update and generate crds * fix: rename to certificate manager * fix: generate venafi-connection-crd * Update deploy/charts/venafi-kubernetes-agent/Chart.yaml Co-authored-by: Atanas Chuchev <[email protected]> * Update pkg/client/client_venafi_cloud.go Co-authored-by: Atanas Chuchev <[email protected]> * Update deploy/charts/venafi-kubernetes-agent/values.yaml Co-authored-by: Atanas Chuchev <[email protected]> * fix: generate crds * fix: run generage * Update deploy/charts/venafi-kubernetes-agent/values.yaml Co-authored-by: Atanas Chuchev <[email protected]> * fix: run generate commands --------- Co-authored-by: Atanas Chuchev <[email protected]>
1 parent 558fde0 commit 01ac27d

File tree

13 files changed

+167
-158
lines changed

13 files changed

+167
-158
lines changed

LICENSES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ github.com/go418/concurrentcache,Apache-2.0
6161
github.com/go418/concurrentcache/logger,Apache-2.0
6262
github.com/gogo/protobuf,BSD-3-Clause
6363
github.com/golang-jwt/jwt/v4,MIT
64+
github.com/golang-jwt/jwt/v5,MIT
6465
github.com/google/btree,Apache-2.0
6566
github.com/google/cel-go,Apache-2.0
6667
github.com/google/cel-go,BSD-3-Clause

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Venafi Kubernetes Agent
1+
# Discovery Agent
22

33
[![tests](https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml/badge.svg?branch=master&event=push)](https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml)
44
[![Go Reference](https://pkg.go.dev/badge/github.com/jetstack/jetstack-secure.svg)](https://pkg.go.dev/github.com/jetstack/jetstack-secure)
@@ -30,6 +30,7 @@ go run . agent \
3030
```
3131

3232
> Some examples of agent configuration files:
33+
>
3334
> - [./agent.yaml](./agent.yaml).
3435
> - [./examples/one-shot-secret.yaml](./examples/one-shot-secret.yaml).
3536
> - [./examples/cert-manager-agent.yaml](./examples/cert-manager-agent.yaml).
@@ -61,5 +62,5 @@ The following metrics are collected:
6162

6263
An end to end test script is available in the [./hack/e2e/test.sh](./hack/e2e/test.sh) directory. It is configured to run in CI
6364
in the tests.yaml GitHub Actions workflow. To run the script you will need to add the `test-e2e` label to the PR.
64-
The script creates a cluster in GKE and cleanups after itself unless the `keep-e2e-cluster` label is set on the PR. Adding that
65-
label will leave the cluster running for further debugging but it will incur costs so manually delete the cluster when done.
65+
The script creates a cluster in GKE and cleanups after itself unless the `keep-e2e-cluster` label is set on the PR. Adding that
66+
label will leave the cluster running for further debugging but it will incur costs so manually delete the cluster when done.

RELEASE.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The release process is semi-automated.
1010
> [!NOTE]
1111
>
1212
> Upon pushing the tag, a GitHub Action will do the following:
13+
>
1314
> - Build and publish the container image: `quay.io/jetstack/venafi-agent`,
1415
> - Build and publish the Helm chart: `oci://quay.io/jetstack/charts/venafi-kubernetes-agent`,
1516
> - Build and publish the container image: `quay.io/jetstack/disco-agent`,
@@ -20,28 +21,30 @@ The release process is semi-automated.
2021

2122
You will need to install `go-mod-upgrade`:
2223

23-
```bash
24-
go install github.com/oligot/go-mod-upgrade@latest
25-
```
24+
```bash
25+
go install github.com/oligot/go-mod-upgrade@latest
26+
```
2627

27-
Then, run the following:
28+
Then, run the following:
2829

29-
```bash
30-
go-mod-upgrade
31-
make generate
32-
```
30+
```bash
31+
go-mod-upgrade
32+
make generate
33+
```
3334

34-
Finally, create a PR with the changes and merge it.
35+
Finally, create a PR with the changes and merge it.
3536

3637
2. Open the [tests GitHub Actions workflow][tests-workflow]
3738
and verify that it succeeds on the master branch.
3839

3940
3. Run govulncheck:
41+
4042
```bash
4143
make verify-govulncheck
4244
```
4345

4446
4. Create a tag for the new release:
47+
4548
```sh
4649
export VERSION=v1.1.0
4750
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
@@ -51,6 +54,7 @@ The release process is semi-automated.
5154
5. Wait until the GitHub Actions finishes.
5255

5356
6. Navigate to the GitHub Releases page and select the draft release to edit.
57+
5458
1. Click on “Generate release notes” to automatically compile the changelog.
5559
2. Review and refine the generated notes to ensure they’re clear and useful
5660
for end users.
@@ -59,7 +63,7 @@ The release process is semi-automated.
5963

6064
7. Publish the release.
6165

62-
8. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
66+
8. Inform the `#venctl` channel that a new version of Discovery Agent has been
6367
released. Make sure to share any breaking change that may affect `venctl connect`
6468
or `venctl generate`.
6569

@@ -73,7 +77,7 @@ The release process is semi-automated.
7377
For context, the new tag will create the following images:
7478

7579
| Image | Automation |
76-
|-----------------------------------------------------------|----------------------------------------------------------------------------------------------|
80+
| --------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
7781
| `quay.io/jetstack/venafi-agent` | Automatically built by the [release action](.github/workflows/release.yml) on Git tag pushes |
7882
| `quay.io/jetstack/disco-agent` | Automatically built by the [release action](.github/workflows/release.yml) on Git tag pushes |
7983
| `registry.venafi.cloud/venafi-agent/venafi-agent` | Automatically mirrored by Harbor Replication rule |
@@ -83,7 +87,7 @@ For context, the new tag will create the following images:
8387
and the following OCI Helm charts:
8488

8589
| Helm Chart | Automation |
86-
|----------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
90+
| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
8791
| `oci://quay.io/jetstack/charts/venafi-kubernetes-agent` | Automatically built by the [release action](.github/workflows/release.yml) on Git tag pushes |
8892
| `oci://quay.io/jetstack/charts/disco-agent` | Automatically built by the [release action](.github/workflows/release.yml) on Git tag pushes |
8993
| `oci://registry.venafi.cloud/charts/venafi-kubernetes-agent` | Automatically mirrored by Harbor Replication rule |

deploy/charts/venafi-kubernetes-agent/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: venafi-kubernetes-agent
33
type: application
44

55
description: |-
6-
The Venafi Kubernetes Agent connects your Kubernetes or Openshift cluster to the Venafi Control Plane.
6+
The Discovery Agent connects your Kubernetes or OpenShift cluster to the CyberArk Certificate Manager.
77
88
maintainers:
99
- name: Venafi

deploy/charts/venafi-kubernetes-agent/README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# venafi-kubernetes-agent
22

3-
The Venafi Kubernetes Agent connects your Kubernetes or OpenShift cluster to the Venafi Control Plane.
4-
You will require a Venafi Control Plane account to connect your cluster.
3+
The Discovery Agent connects your Kubernetes or OpenShift cluster to the CyberArk Certificate Manager (formerly Venafi Control Plane).
4+
You will require a CyberArk Certificate Manager account to connect your cluster.
55
If you do not have one, you can sign up for a free trial now at:
6+
67
- https://venafi.com/try-venafi/tls-protect/
78

8-
> 📖 Read the [Venafi Kubernetes Agent documentation](https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/),
9+
> 📖 Read the [Discovery Agent documentation](https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/),
910
> to learn how install and configure this Helm chart.
1011
1112
## Values
@@ -104,7 +105,7 @@ default replicas, do not scale up
104105
> registry.venafi.cloud/venafi-agent/venafi-agent
105106
> ```
106107
107-
The container image for the Venafi Enhanced Issuer manager.
108+
The container image for the Discovery Agent.
108109
#### **image.pullPolicy** ~ `string`
109110
> Default value:
110111
> ```yaml
@@ -282,7 +283,7 @@ extraArgs:
282283
> []
283284
> ```
284285
285-
Additional volumes to add to the Venafi Kubernetes Agent container. This is useful for mounting a custom CA bundle. For example:
286+
Additional volumes to add to the Discovery Agent container. This is useful for mounting a custom CA bundle. For example:
286287
287288
```yaml
288289
volumes:
@@ -303,7 +304,7 @@ In order to create the ConfigMap, you can use the following command:
303304
> []
304305
> ```
305306
306-
Additional volume mounts to add to the Venafi Kubernetes Agent container. This is useful for mounting a custom CA bundle. Any PEM certificate mounted under /etc/ssl/certs will be loaded by the Venafi Kubernetes Agent. For
307+
Additional volume mounts to add to the Discovery Agent container. This is useful for mounting a custom CA bundle. Any PEM certificate mounted under /etc/ssl/certs will be loaded by the Discovery Agent. For
307308
308309
```yaml
309310
example:
@@ -342,8 +343,8 @@ Configure VenafiConnection authentication
342343
> false
343344
> ```
344345
345-
When set to true, the Venafi Kubernetes Agent will authenticate to. Venafi using the configuration in a VenafiConnection resource. Use `venafiConnection.enabled=true` for [secretless authentication](https://docs.venafi.cloud/vaas/k8s-components/t-install-tlspk-agent/). When set to true, the `authentication.secret` values will be ignored and the. Secret with `authentication.secretName` will _not_ be mounted into the
346-
Venafi Kubernetes Agent Pod.
346+
When set to true, the Discovery Agent will authenticate to. Venafi using the configuration in a VenafiConnection resource. Use `venafiConnection.enabled=true` for [secretless authentication](https://docs.venafi.cloud/vaas/k8s-components/t-install-tlspk-agent/). When set to true, the `authentication.secret` values will be ignored and the. Secret with `authentication.secretName` will _not_ be mounted into the
347+
Discovery Agent Pod.
347348
#### **authentication.venafiConnection.name** ~ `string`
348349
> Default value:
349350
> ```yaml
@@ -364,7 +365,7 @@ The namespace of a VenafiConnection resource which contains the configuration fo
364365
> https://api.venafi.cloud/
365366
> ```
366367
367-
API URL of the Venafi Control Plane API. For EU tenants, set this value to https://api.venafi.eu/. If you are using the VenafiConnection authentication method, you must set the API URL using the field `spec.vcp.url` on the
368+
API URL of the CyberArk Certificate Manager API. For EU tenants, set this value to https://api.venafi.eu/. If you are using the VenafiConnection authentication method, you must set the API URL using the field `spec.vcp.url` on the
368369
VenafiConnection resource instead.
369370
#### **config.clientId** ~ `string`
370371
> Default value:
@@ -373,7 +374,7 @@ VenafiConnection resource instead.
373374
> ```
374375
375376
The client-id to be used for authenticating with the Venafi Control. Plane. Only useful when using a Key Pair Service Account in the Venafi. Control Plane. You can obtain the cliend ID by creating a Key Pair Service
376-
Account in the Venafi Control Plane.
377+
Account in the CyberArk Certificate Manager.
377378
#### **config.period** ~ `string`
378379
> Default value:
379380
> ```yaml
@@ -438,7 +439,7 @@ Control Plane.
438439
> []
439440
> ```
440441
441-
You can configure Venafi Kubernetes Agent to exclude some annotations or labels from being pushed to the Venafi Control Plane. All Kubernetes objects are affected. The objects are still pushed, but the specified annotations and labels are removed before being sent to the Venafi Control Plane.
442+
You can configure Discovery Agent to exclude some annotations or labels from being pushed to the CyberArk Certificate Manager. All Kubernetes objects are affected. The objects are still pushed, but the specified annotations and labels are removed before being sent to the CyberArk Certificate Manager.
442443
443444
Dots is the only character that needs to be escaped in the regex. Use either double quotes with escaped single quotes or unquoted strings for the regex to avoid YAML parsing issues with `\.`.
444445
@@ -501,4 +502,4 @@ This option makes it so that the "helm.sh/resource-policy": keep annotation is a
501502
502503
When set to false, the rendered output does not contain the. VenafiConnection CRDs and RBAC. This is useful for when the. Venafi Connection resources are already installed separately.
503504
504-
<!-- /AUTO-GENERATED -->
505+
<!-- /AUTO-GENERATED -->

0 commit comments

Comments
 (0)