Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Venafi Kubernetes Agent
# Discovery Agent for CyberArk Certificate Manager in Kubernetes and OpenShift Environments

[![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)
[![Go Reference](https://pkg.go.dev/badge/github.com/jetstack/jetstack-secure.svg)](https://pkg.go.dev/github.com/jetstack/jetstack-secure)
Expand All @@ -8,7 +8,7 @@

## Installation

Please [review the documentation](https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/) for the agent.
Please [review the documentation](https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/) for the Discovery Agent for CyberArk Certificate Manager in Kubernetes and OpenShift Environments (formerly Venafi Kubernetes Agent).

Detailed installation instructions are available for a variety of methods.

Expand Down Expand Up @@ -46,7 +46,7 @@ The agent exposes its metrics through a Prometheus server, on port 8081.

The Prometheus server is disabled by default but can be enabled by passing the `--enable-metrics` flag to the agent binary.

If you deploy the agent using the venafi-kubernetes-agent Helm chart, the metrics server will be enabled by default, on port 8081.
If you deploy the agent using the venafi-kubernetes-agent Helm chart (Discovery Agent), the metrics server will be enabled by default, on port 8081.

If you use the Prometheus Operator, you can use `--set metrics.podmonitor.enabled=true` to deploy a `PodMonitor` resource,
which will add the venafi-kubernetes-agent metrics to your Prometheus server.
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The release process is semi-automated.

7. Publish the release.

8. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
8. Inform the `#venctl` channel that a new version of the Discovery Agent for CyberArk Certificate Manager in Kubernetes and OpenShift Environments has been
released. Make sure to share any breaking change that may affect `venctl connect`
or `venctl generate`.

Expand Down
8 changes: 4 additions & 4 deletions deploy/charts/venafi-kubernetes-agent/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: venafi-kubernetes-agent
type: application

description: |-
The Venafi Kubernetes Agent connects your Kubernetes or Openshift cluster to the Venafi Control Plane.
The Discovery Agent for CyberArk Certificate Manager in Kubernetes and OpenShift Environments connects your Kubernetes or OpenShift cluster to the CyberArk Control Plane.

maintainers:
- name: Venafi
email: support@venafi.cloud
url: https://venafi.com
- name: CyberArk
email: support@cyberark.com
url: https://www.cyberark.com

sources:
- https://github.com/jetstack/jetstack-secure
Expand Down
19 changes: 9 additions & 10 deletions deploy/charts/venafi-kubernetes-agent/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# venafi-kubernetes-agent
# discovery-agent-for-cyberark-certificate-manager-in-kubernetes-and-openshift-environments

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

> 📖 Read the [Venafi Kubernetes Agent documentation](https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/),
> to learn how install and configure this Helm chart.
> 📖 Read the Discovery Agent documentation for CyberArk Certificate Manager (formerly Venafi Kubernetes Agent):
> https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/

## Values

Expand Down Expand Up @@ -282,7 +282,7 @@ extraArgs:
> []
> ```

Additional volumes to add to the Venafi Kubernetes Agent container. This is useful for mounting a custom CA bundle. For example:
Additional volumes to add to the Discovery Agent container. This is useful for mounting a custom CA bundle. For example:

```yaml
volumes:
Expand All @@ -303,7 +303,7 @@ In order to create the ConfigMap, you can use the following command:
> []
> ```

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
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

```yaml
example:
Expand Down Expand Up @@ -342,8 +342,7 @@ Configure VenafiConnection authentication
> false
> ```

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
Venafi Kubernetes Agent Pod.
When set to true, the Discovery Agent will authenticate to CyberArk Certificate Manager 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 Discovery Agent Pod.
#### **authentication.venafiConnection.name** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -438,7 +437,7 @@ Control Plane.
> []
> ```

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.
You can configure Discovery Agent to exclude some annotations or labels from being pushed to the CyberArk Certificate Manager 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 CyberArk Certificate Manager Control Plane.

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 `\.`.

Expand Down
6 changes: 3 additions & 3 deletions deploy/charts/venafi-kubernetes-agent/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
},
"helm-values.authentication.venafiConnection.enabled": {
"default": false,
"description": "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\nVenafi Kubernetes Agent Pod.",
"description": "When set to true, the Discovery Agent will authenticate to CyberArk Certificate Manager 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 Discovery Agent Pod.",
"type": "boolean"
},
"helm-values.authentication.venafiConnection.name": {
Expand Down Expand Up @@ -214,7 +214,7 @@
"helm-values.config.configmap.name": {},
"helm-values.config.excludeAnnotationKeysRegex": {
"default": [],
"description": "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.\n\nDots 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 `\\.`.\n\nExample: excludeAnnotationKeysRegex: ['^kapp\\.k14s\\.io/original.*']",
"description": "You can configure Discovery Agent to exclude some annotations or labels from being pushed to the CyberArk Certificate Manager 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 CyberArk Certificate Manager Control Plane.\n\nDots 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 `\\.`.\n\nExample: excludeAnnotationKeysRegex: ['^kapp\\.k14s\\.io/original.*']",
"items": {},
"type": "array"
},
Expand Down Expand Up @@ -264,7 +264,7 @@
},
"helm-values.config.server": {
"default": "https://api.venafi.cloud/",
"description": "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\nVenafiConnection resource instead.",
"description": "API URL of the CyberArk Certificate Manager 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\nVenafiConnection resource instead.",
"type": "string"
},
"helm-values.crds": {
Expand Down
12 changes: 6 additions & 6 deletions deploy/charts/venafi-kubernetes-agent/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ command: []
# - --log-level=6 # To enable HTTP request logging
extraArgs: []

# Additional volumes to add to the Venafi Kubernetes Agent container. This is
# Additional volumes to add to the Discovery Agent container. This is
# useful for mounting a custom CA bundle. For example:
#
# volumes:
Expand All @@ -178,7 +178,7 @@ extraArgs: []
# --from-file=cabundle=./your/custom/ca/bundle.pem
volumes: []

# Additional volume mounts to add to the Venafi Kubernetes Agent container.
# 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 Venafi Kubernetes Agent. For
# example:
Expand All @@ -190,7 +190,7 @@ volumes: []
# readOnly: true
volumeMounts: []

# Authentication details for the Venafi Kubernetes Agent
# Authentication details for the Discovery Agent
authentication:
# Name of the secret containing the private key
secretName: agent-credentials
Expand All @@ -200,8 +200,8 @@ authentication:
# +docs:section=Venafi Connection
# Configure VenafiConnection authentication
venafiConnection:
# When set to true, the Venafi Kubernetes Agent will authenticate to
# Venafi using the configuration in a VenafiConnection resource.
# When set to true, the Discovery Agent will authenticate to
# CyberArk Certificate Manager 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
Expand All @@ -216,7 +216,7 @@ authentication:

# Configuration section for the Venafi Kubernetes Agent itself
config:
# API URL of the Venafi Control Plane API. For EU tenants, set this value to
# API URL of the CyberArk Certificate Manager 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
# VenafiConnection resource instead.
Expand Down
2 changes: 1 addition & 1 deletion internal/cyberark/dataupload/dataupload.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func New(httpClient *http.Client, baseURL string, authenticateRequest func(req *
// Snapshot is the JSON that the CyberArk Discovery and Context API expects to
// be uploaded to the AWS presigned URL.
type Snapshot struct {
// AgentVersion is the version of the Venafi Kubernetes Agent which is uploading this snapshot.
// AgentVersion is the version of the Discovery Agent which is uploading this snapshot.
AgentVersion string `json:"agent_version"`
// ClusterID is the unique ID of the Kubernetes cluster which this snapshot was taken from.
ClusterID string `json:"cluster_id"`
Expand Down
4 changes: 2 additions & 2 deletions make/00_mod.mk
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ oci_preflight_image_name_development := jetstack.local/venafi-agent
oci_preflight_build_args := \
--image-annotation="org.opencontainers.image.vendor"="CyberArk Software Ltd." \
--image-annotation="org.opencontainers.image.licenses"="EULA - https://www.cyberark.com/contract-terms/" \
--image-annotation="org.opencontainers.image.authors"="support@venafi.cloud" \
--image-annotation="org.opencontainers.image.title"="Venafi Kubernetes Agent" \
--image-annotation="org.opencontainers.image.authors"="support@cyberark.com" \
--image-annotation="org.opencontainers.image.title"="Discovery Agent for CyberArk Certificate Manager in Kubernetes and OpenShift Environments" \
--image-annotation="org.opencontainers.image.description"="Gathers machine identity data from Kubernetes clusters." \
--image-annotation="org.opencontainers.image.url"="https://www.cyberark.com/products/certificate-manager-for-kubernetes/" \
--image-annotation="org.opencontainers.image.documentation"="https://docs.venafi.cloud/vaas/k8s-components/c-tlspk-agent-overview/" \
Expand Down
2 changes: 1 addition & 1 deletion pkg/client/client_venafi_cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ func (c *VenafiCloudClient) sendHTTPRequest(request *http.Request, responseObjec

if response.StatusCode != http.StatusOK && response.StatusCode != http.StatusCreated {
body, _ := io.ReadAll(response.Body)
return fmt.Errorf("failed to execute http request to Venafi Control Plane. Request %s, status code: %d, body: [%s]", request.URL, response.StatusCode, body)
return fmt.Errorf("failed to execute http request to CyberArk Certificate Manager Control Plane. Request %s, status code: %d, body: [%s]", request.URL, response.StatusCode, body)
}

body, err := io.ReadAll(response.Body)
Expand Down
Loading