Skip to content

Commit

Permalink
Merge pull request #33 from Conjur-Enterprise/bump-to-v1.6.5
Browse files Browse the repository at this point in the history
CNJR-4654: Bump to v1.6.5
  • Loading branch information
imheresamir authored and GitHub Enterprise committed Jul 24, 2024
2 parents 717a25b + 34ce990 commit abea56e
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 50 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

## [1.6.5] - 2024-04-25
## [1.6.5] - 2024-07-24

### Security
- Upgrade golang.org/x/net to v0.24.0 (CONJSE-1863)
Expand Down Expand Up @@ -337,7 +337,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed
- Escape secrets with backslashes before patching in k8s

[Unreleased]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.6.4...HEAD
[Unreleased]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.6.5...HEAD
[1.6.5]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.6.4...v1.6.5
[1.6.4]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.6.3...v1.6.4
[1.6.3]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.6.2...v1.6.3
[1.6.2]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.6.1...v1.6.2
Expand Down
77 changes: 39 additions & 38 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,29 @@ Thanks for your interest in the CyberArk Secrets Provider for Kubernetes. We wel
## Table of Contents

- [Contributing to the CyberArk Secrets Provider for Kubernetes](#contributing-to-the-cyberark-secrets-provider-for-kubernetes)
* [Prerequisites](#prerequisites)
+ [Go](#go)
* [Documentation](#documentation)
+ [Get up and running](#get-up-and-running)
+ [Deploy a Local Dev Environment (K8s)](#deploy-a-local-dev-environment-k8s)
- [Table of Contents](#table-of-contents)
- [Prerequisites](#prerequisites)
- [Go](#go)
- [Documentation](#documentation)
- [Get up and running](#get-up-and-running)
- [Deploy a Local Dev Environment (K8s)](#deploy-a-local-dev-environment-k8s)
- [Prerequisites](#prerequisites-1)
- [Deploy a local development environment](#deploy-a-local-development-environment)
- [Run integration tests against local development environment](#run-integration-tests-against-local-development-environment)
- [Clean-up](#clean-up)
- [Limitations](#limitations)
* [Contributing](#contributing)
+ [Contributing workflow](#contributing-workflow)
+ [Testing](#testing)
- [Contributing](#contributing)
- [Contributing workflow](#contributing-workflow)
- [Testing](#testing)
- [Unit testing](#unit-testing)
- [Integration testing](#integration-testing)
* [Releases](#releases)
+ [Pre-requisites](#pre-requisites)
+ [Update the version, changelog, and notices](#update-the-version-changelog-and-notices)
+ [Push Helm package](#push-helm-package)
+ [Release and Promote](#release-and-promote)
+ [Publish the Red Hat image](#publish-the-red-hat-image)
- [Tracing](#tracing)
- [Releases](#releases)
- [Pre-requisites](#pre-requisites)
- [Update the version, changelog, and notices](#update-the-version-changelog-and-notices)
- [Push Helm package](#push-helm-package)
- [Release and Promote](#release-and-promote)
- [Publish the Red Hat image](#publish-the-red-hat-image)

## Prerequisites

Expand All @@ -40,21 +43,21 @@ The full documentation for the Cyberark Secrets Provider for Kubernetes can be f

Before you can start contributing to the CyberArk Secrets Provider for Kubernetes project, you must:

1. Setup your environment.
1. Setup your environment.

a. For detailed instructions on how to setup a Conjur Enterprise env, see [Conjur Enterprise Setup](https://docs.cyberark.com/Product-Doc/OnlineHelp/AAM-DAP/Latest/en/Content/HomeTilesLPs/LP-Tile1.htm).

b. For detailed instructions on how to setup a Conjur Open Source env, see [Conjur Open Source Setup](https://docs.conjur.org/Latest/en/Content/HomeTilesLPs/LP-Tile1.htm).

2. Setup the CyberArk Secrets Provider for Kubernetes

a. For detailed setup instructions for Conjur Enterprise, see [CyberArk Secrets Provider for Kubernetes for Conjur Enterprise](https://docs.cyberark.com/Product-Doc/OnlineHelp/AAM-DAP/Latest/en/Content/Integrations/Kubernetes_deployApplicationsConjur-k8s-Secrets.htm).

b. For detailed setup instructions for Conjur Open Source, see [CyberArk Secrets Provider for Kubernetes for Conjur Open Source](https://docs.conjur.org/Latest/en/Content/Integrations/Kubernetes_deployApplicationsConjur-k8s-Secrets.htm).

### Deploy a Local Dev Environment (K8s)

You can now deploy a local development environment for Kubernetes using [Docker Desktop](https://www.docker.com/products/docker-desktop). Docker Desktop provides a convenient way to deploy and develop from your machine against a locally deployed cluster.
You can now deploy a local development environment for Kubernetes using [Docker Desktop](https://www.docker.com/products/docker-desktop). Docker Desktop provides a convenient way to deploy and develop from your machine against a locally deployed cluster.

#### Prerequisites

Expand All @@ -63,25 +66,25 @@ You can now deploy a local development environment for Kubernetes using [Docker
1. Kubernetes enabled in Docker Desktop

1. Navigate to Docker Preferences

1. Click on the Kubernetes tab and "Enable Kubernetes"
1. The Secrets Provider for K8s uses the [Kubernetes Conjur deploy](https://github.com/cyberark/kubernetes-conjur-deploy/blob/master/CONTRIBUTING.md) repository to deploy Conjur Enterprise / Conjur Open Source on Kubernetes.

1. The Secrets Provider for K8s uses the [Kubernetes Conjur deploy](https://github.com/cyberark/kubernetes-conjur-deploy/blob/master/CONTRIBUTING.md) repository to deploy Conjur Enterprise / Conjur Open Source on Kubernetes.
By default, 2.0 Gib of memory is allocated to Docker on your computer.

To successfully deploy a Conjur Enterprise cluster (Leader + Followers + Standbys), you will need to increase the memory limit to 6 Gib. To do so, perform the following:

1. Navigate to Docker preferences

1. Click on "Resources" and slide the "Memory" bar to 6

1. If you intend to deploy the Secrets Provider via Helm, you will need to install the Helm CLI. See [here](https://helm.sh/docs/intro/install/) for instructions on how to do so.

#### Deploy a local development environment

To deploy a local development environment, perform the following:

1. Run `./bin/build` to build the Secrets Provider image locally
1. Run `./bin/build` to build the Secrets Provider image locally

1. Ensure you are in the proper local context. Otherwise, the deployment will not run successfully

Expand All @@ -93,7 +96,7 @@ Run `kubectl config use-context docker-desktop` to switch to a local context. Th

1. Run `./bin/start --dev`, appending `--oss` or `--dap` according to the environment that needs to be deployed

1. To view the pod(s) that were deployed and the Secrets Provider logs, run `kubectl get pods` and `kubectl logs <pod-name> -c cyberark-secrets-provider-for-k8s` respectively.
1. To view the pod(s) that were deployed and the Secrets Provider logs, run `kubectl get pods` and `kubectl logs <pod-name> -c cyberark-secrets-provider-for-k8s` respectively.
You can also view Conjur Enterprise / Conjur Open Source pod logs by running `kubectl get pods -n local-conjur` and `kubectl logs <conjur-pod-name> -n local-conjur`

1. If a cluster is already locally deployed run `./bin/start --dev --reload` to build your local changes and redeploy them to the local Secrets Provider K8s cluster
Expand Down Expand Up @@ -162,10 +165,10 @@ To follow [Go testing conventions](https://golang.org/pkg/cmd/go/internal/test/)
1. Create tests.

1. Run test suite, `./bin/test_unit`

#### Integration testing

Our integration tests can be run against either a GKE / Openshift remote cluster. To do so, run `./bin/start` and add the proper flags.
Our integration tests can be run against either a GKE / Openshift remote cluster. To do so, run `./bin/start` and add the proper flags.

To deploy Conjur Enterprise / Conjur Open Source, add the `--oss` / `--dap` flags to the above command. By default, the integration tests run Conjur Enterprise, so no flag is required.
To deploy on GKE, add `--gke`. For Openshift, use `--oldest` / `--current` / `--next`. By default, the integration tests run on a GKE cluster,
Expand All @@ -186,7 +189,7 @@ When contributing new integration tests, perform the following:

1. Create a new test file with filename prefix `TEST_ID_<HIGHEST_NUMBER>_<TEST_NAME>`

If your tests follow the above instructions, our scripts should grab your test additions and run it as our test suite.
If your tests follow the above instructions, our scripts should grab your test additions and run it as our test suite.

That's it!
Expand Down Expand Up @@ -240,7 +243,7 @@ follow the instructions in this section.
1. Review the changes since the last tag, and if the dependencies have changed
revise the [NOTICES](NOTICES.txt) to correctly capture the included
dependencies and their licenses / copyrights.
1. Ensure that all documentation that needs to be written has been
1. Ensure that all documentation that needs to be written has been
written by TW, approved by PO/Engineer, and pushed to the forward-facing documentation.
1. Scan the project for vulnerabilities
Expand All @@ -251,15 +254,13 @@ follow the instructions in this section.
1. Update this version in the following files:
1. [version.go](pkg/secrets/version.go)
1. [Chart version](helm/secrets-provider/Chart.yaml)
1. [Default deployed version](helm/secrets-provider/values.yaml)
1. [Helm unit test for chart defaults](helm/secrets-provider/tests/secrets_provider_test.yaml)
1. [Test case hardcoded version](deploy/test/test_cases/TEST_ID_22_helm_rbac_defaults_taken_successfully.sh)
1. Commit these changes - `Bump version to x.y.z` is an acceptable commit
2. [Helm unit test for chart defaults](helm/secrets-provider/tests/secrets_provider_test.yaml)
2. Commit these changes - `Bump version to x.y.z` is an acceptable commit
message - and open a PR for review.
### Push Helm package
1. Every build packages the Secrets Provider Helm chart for us. The package can be found under the 'Artifacts' tab of the Jenkins build and will resemble `secrets-provider-<version>.tgz`.
1. Every build packages the Secrets Provider Helm chart for us. The package can be found under the 'Artifacts' tab of the Jenkins build and will resemble `secrets-provider-<version>.tgz`.
Navigate to the 'Artifacts' tab of the _tagged version_ build and save this file. You will need it for the next step.
1. Clone the repo [helm-charts](https://github.com/cyberark/helm-charts) and do the following:
1. Move the Helm package file created in the previous step to the *docs* folder in the `helm-charts` repo.
Expand Down
8 changes: 4 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QH
github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/cyberark/conjur-api-go v0.11.1 h1:vjaMkw0geJsA+ikMM6UDLg4VLFQWKo/B0i9IWlOQ1f0=
github.com/cyberark/conjur-api-go v0.11.1/go.mod h1:n1p46Hj9l8wkZjM17cVYdfcatyPboWyioLGlC0QszCs=
github.com/cyberark/conjur-authn-k8s-client v0.26.1 h1:eod150C7iBDXu1AdFF6si7RH93M0NKpt97qbgEKYWCA=
github.com/cyberark/conjur-authn-k8s-client v0.26.1/go.mod h1:Jqbs1zWeaG2MY0jFNlmpGRKg3m5XqXBYVR2Kw88oXDk=
github.com/cyberark/conjur-api-go v0.12.3 h1:LzSXJBKO36WJEcFceXYyb3y9lxHwx5WMhx/YH+RW88M=
github.com/cyberark/conjur-api-go v0.12.3/go.mod h1:FnzNn6mPwTOyBueSDnu1J4K47J0sYHXTMehaqIV/GxY=
github.com/cyberark/conjur-authn-k8s-client v0.26.2 h1:HEjS7f6wpItnPbse6CQ/Dp3aHGeXTgnKjpl1RPdE2sA=
github.com/cyberark/conjur-authn-k8s-client v0.26.2/go.mod h1:C57WW0NZyinwsVuRFSKEHkrxw0L3kXZ5Lb7BAosOxdA=
github.com/cyberark/conjur-opentelemetry-tracer v0.0.2 h1:HMC5fDg6tyIlNJq4jMdMs0nGt0Ml23U+KUIyld4f+tY=
github.com/cyberark/conjur-opentelemetry-tracer v0.0.2/go.mod h1:hn2e6WYNnB6lPKbnLg1jHZkBNT4mgH3/u7kH1hK60A0=
github.com/danieljoos/wincred v1.1.2 h1:QLdCxFs1/Yl4zduvBdcHB8goaYk9RARS2SgLLRuAyr0=
Expand Down
2 changes: 1 addition & 1 deletion helm/secrets-provider/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v1
description: A Helm chart for deploying CyberArk Secrets Provider for Kubernetes
name: secrets-provider
version: 1.6.4
version: 1.6.5
home: https://github.com/cyberark/secrets-provider-for-k8s
icon: https://www.cyberark.com/wp-content/uploads/2015/12/cybr-aim.jpg
2 changes: 1 addition & 1 deletion helm/secrets-provider/tests/secrets_provider_test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ tests:
# Confirm that default chart values have been used
- equal:
path: spec.template.spec.containers[0].image
value: docker.io/cyberark/secrets-provider-for-k8s:1.6.4
value: docker.io/cyberark/secrets-provider-for-k8s:1.6.5
- equal:
path: spec.template.spec.containers[0].imagePullPolicy
value: IfNotPresent
Expand Down
6 changes: 3 additions & 3 deletions helm/secrets-provider/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,17 @@ environment:
# This setting is required if 'conjurConnConfigMap' is not set.
#
# account:

# URL of service defined for DAP Follower/Conjur.
# This setting is required if 'conjurConnConfigMap' is not set.
#
# applianceUrl:

# URL for the Kubernetes authenticator with which the Secrets Provider will authenticate.
# This setting is required if 'conjurConnConfigMap' is not set.
#
# authnUrl:

sslCertificate:
# Name of ConfigMap that holds the public SSL certificate required for connecting to Follower/Conjur.
name: cert-config-map
Expand Down
2 changes: 1 addition & 1 deletion pkg/secrets/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package secrets
import "fmt"

// Version field is a SemVer that should indicate the baked-in version
var Version = "1.6.4"
var Version = "1.6.5"

// Tag field denotes the specific build type for the broker. It may
// be replaced by compile-time variables if needed to provide the git
Expand Down

0 comments on commit abea56e

Please sign in to comment.