Skip to content

Commit b3be8b4

Browse files
akosasiGitHub Enterprise
authored andcommitted
Merge pull request #68 from Conjur-Enterprise/name-change
CNJR-10982: Name Change Updates
2 parents a3a292e + 84c29aa commit b3be8b4

11 files changed

Lines changed: 75 additions & 178 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
66

77
## [Unreleased]
88

9-
## [1.7.5] - 2025-04-01
9+
## [1.7.5] - 2025-09-09
10+
11+
### Changed
12+
- Updated documentation to align with Conjur Enterprise name change to Secrets Manager. (CNJR-10982)
1013

1114
## [1.7.4] - 2025-04-01
1215

@@ -368,7 +371,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
368371
### Changed
369372
- Escape secrets with backslashes before patching in k8s
370373

371-
[Unreleased]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.7.4...HEAD
374+
[Unreleased]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.7.5...HEAD
375+
[1.7.5]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.7.4...v1.7.5
372376
[1.7.4]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.7.3...v1.7.4
373377
[1.7.3]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.7.2...v1.7.3
374378
[1.7.2]: https://github.com/cyberark/secrets-provider-for-k8s/compare/v1.7.1...v1.7.2

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,21 @@ To work in this codebase, you will want to have Go version 1.12+ installed.
3737

3838
## Documentation
3939

40-
The full documentation for the Cyberark Secrets Provider for Kubernetes can be found [here](https://docs.cyberark.com/Product-Doc/OnlineHelp/AAM-DAP/Latest/en/Content/Integrations/Kubernetes_deployApplicationsConjur-k8s-Secrets.htm) for Conjur Enterprise and [here](https://docs.conjur.org/Latest/en/Content/Integrations/Kubernetes_deployApplicationsConjur-k8s-Secrets.htm) for Conjur Open Source.
40+
The full documentation for the Cyberark Secrets Provider for Kubernetes can be found [here](https://docs.cyberark.com/conjur-enterprise/latest/en/content/resources/_topnav/cc_home.htm) for Secrets Manager, Self-Hosted and [here](https://docs.cyberark.com/conjur-open-source/latest/en/content/overview/conjur-oss-suite-overview.html) for Conjur Open Source.
4141

4242
### Get up and running
4343

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

4646
1. Setup your environment.
4747

48-
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).
48+
a. For detailed instructions on how to setup a Secrets Manager, Self-Hosted env, see [Secrets Manager, Self-Hosted Setup](https://docs.cyberark.com/Product-Doc/OnlineHelp/AAM-DAP/Latest/en/Content/HomeTilesLPs/LP-Tile1.htm).
4949

5050
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).
5151

5252
2. Setup the CyberArk Secrets Provider for Kubernetes
5353

54-
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).
54+
a. For detailed setup instructions for Secrets Manager, Self-Hosted, see [CyberArk Secrets Provider for Kubernetes for Secrets Manager, Self-Hosted](https://docs.cyberark.com/Product-Doc/OnlineHelp/AAM-DAP/Latest/en/Content/Integrations/Kubernetes_deployApplicationsConjur-k8s-Secrets.htm).
5555

5656
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).
5757

@@ -69,10 +69,10 @@ You can now deploy a local development environment for Kubernetes using [Docker
6969

7070
1. Click on the Kubernetes tab and "Enable Kubernetes"
7171

72-
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.
72+
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 Secrets Manager, Self-Hosted / Conjur Open Source on Kubernetes.
7373
By default, 2.0 Gib of memory is allocated to Docker on your computer.
7474

75-
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:
75+
To successfully deploy a Secrets Manager, Self-Hosted cluster (Leader + Followers + Standbys), you will need to increase the memory limit to 6 Gib. To do so, perform the following:
7676

7777
1. Navigate to Docker preferences
7878

@@ -97,7 +97,7 @@ Run `kubectl config use-context docker-desktop` to switch to a local context. Th
9797
1. Run `./bin/start --dev`, appending `--oss` or `--dap` according to the environment that needs to be deployed
9898

9999
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.
100-
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`
100+
You can also view Secrets Manager, Self-Hosted / Conjur Open Source pod logs by running `kubectl get pods -n local-conjur` and `kubectl logs <conjur-pod-name> -n local-conjur`
101101

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

@@ -170,14 +170,14 @@ To follow [Go testing conventions](https://golang.org/pkg/cmd/go/internal/test/)
170170

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

173-
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.
173+
To deploy Secrets Manager, Self-Hosted / Conjur Open Source, add the `--oss` / `--dap` flags to the above command. By default, the integration tests run Secrets Manager, Self-Hosted, so no flag is required.
174174
To deploy on GKE, add `--gke`. For Openshift, use `--oldest` / `--current` / `--next`. By default, the integration tests run on a GKE cluster,
175175
so no flag is required.
176176

177177
For example:
178178

179179
- Deploy Conjur Open Source on GKE, run `./bin/start --oss --gke`
180-
- Deploy Conjur Enterprise on Openshift, run `./bin/start --dap --current`
180+
- Deploy Secrets Manager, Self-Hosted on Openshift, run `./bin/start --dap --current`
181181

182182
#### Tracing
183183

FETCH_ALL.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Existing Functionality
44

55
In the regular configuration of Secrets Provider, the application developer must
6-
specify each secret that needs to be retrieved from Conjur. This is done in one
6+
specify each secret that needs to be retrieved from Secrets Manager. This is done in one
77
of two ways, depending on how the secrets are being provided:
88

99
### Kubernetes Secrets
@@ -144,7 +144,7 @@ There are several important things to note about this feature:
144144
### Security Implications
145145

146146
- The Fetch All feature should be used with caution, as it can expose more
147-
secrets than intended. Ideally, Conjur should be configured to only allow the
147+
secrets than intended. Ideally, Secrets Manager should be configured to only allow the
148148
host to access the secrets that it needs. Additionally, the host should only
149149
be used for a small unit, such as a single application, and therefore only
150150
need access to a small number of secrets. If the host has access to a large
@@ -157,7 +157,7 @@ There are several important things to note about this feature:
157157
### Performance and Reliability
158158

159159
- Using Fetch All will be slightly slower than specifying each secret
160-
individually, as it requires multiple requests to Conjur - first to list all
160+
individually, as it requires multiple requests to Secrets Manager - first to list all
161161
the available secrets, and then to fetch them. In cases where performance is
162162
critical, it may be better to specify the secrets individually.
163163

@@ -179,12 +179,12 @@ There are several important things to note about this feature:
179179

180180
- There is no way to use aliases for secrets when using the Fetch All feature.
181181
This means that the keys used for the secrets (both in K8s Secrets and P2F)
182-
will be the *full path* of the secret in Conjur. At the same time, Kubernetes
182+
will be the *full path* of the secret in Secrets Manager. At the same time, Kubernetes
183183
secrets do not allow keys to contain slashes (`/`) or most other special
184184
characters. Due to these limitations:
185185

186186
- *In K8s secrets mode:* Any slashes, spaces or other special characters
187-
(besides `_`, `-`, and `.`) in the Conjur secret path will be replaced with
187+
(besides `_`, `-`, and `.`) in the Secrets Manager secret path will be replaced with
188188
dots (`.`) in the key names when using K8s Secrets. For example, if the
189189
secret is stored at `host/my-app/secrets/db-password`, the key in the K8s
190190
Secret will be `host.my-app.secrets.db-password`.
@@ -199,7 +199,7 @@ There are several important things to note about this feature:
199199
will be ignored. This will cause non-deterministic behavior in the
200200
application and must be avoided.
201201

202-
- *In P2F mode:* The key names will be the full path of the secret in Conjur.
202+
- *In P2F mode:* The key names will be the full path of the secret in Secrets Manager.
203203
For example, if the secret is stored at `host/my-app/secrets/db-password`,
204204
the key in the P2F file will be `host/my-app/secrets/db-password`.
205205
This poses no issues for YAML and JSON files, since those formats

0 commit comments

Comments
 (0)