You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,21 +37,21 @@ To work in this codebase, you will want to have Go version 1.12+ installed.
37
37
38
38
## Documentation
39
39
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.
41
41
42
42
### Get up and running
43
43
44
44
Before you can start contributing to the CyberArk Secrets Provider for Kubernetes project, you must:
45
45
46
46
1. Setup your environment.
47
47
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).
49
49
50
50
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).
51
51
52
52
2. Setup the CyberArk Secrets Provider for Kubernetes
53
53
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).
55
55
56
56
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).
57
57
@@ -69,10 +69,10 @@ You can now deploy a local development environment for Kubernetes using [Docker
69
69
70
70
1. Click on the Kubernetes tab and "Enable Kubernetes"
71
71
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.
73
73
By default, 2.0 Gib of memory is allocated to Docker on your computer.
74
74
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:
76
76
77
77
1. Navigate to Docker preferences
78
78
@@ -97,7 +97,7 @@ Run `kubectl config use-context docker-desktop` to switch to a local context. Th
97
97
1. Run `./bin/start --dev`, appending `--oss` or `--dap` according to the environment that needs to be deployed
98
98
99
99
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`
101
101
102
102
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
103
103
@@ -170,14 +170,14 @@ To follow [Go testing conventions](https://golang.org/pkg/cmd/go/internal/test/)
170
170
171
171
Our integration tests can be run against either a GKE / Openshift remote cluster. To do so, run `./bin/start` and add the proper flags.
172
172
173
-
To deploy ConjurEnterprise/ ConjurOpenSource, add the `--oss` / `--dap` flags to the above command. Bydefault, the integration tests run ConjurEnterprise, so no flag is required.
173
+
To deploy SecretsManager, Self-Hosted / ConjurOpenSource, add the `--oss` / `--dap` flags to the above command. Bydefault, the integration tests run SecretsManager, Self-Hosted, so no flag is required.
174
174
To deploy on GKE, add `--gke`. ForOpenshift, use `--oldest` / `--current` / `--next`. Bydefault, the integration tests run on a GKE cluster,
175
175
so no flag is required.
176
176
177
177
For example:
178
178
179
179
- DeployConjurOpenSource on GKE, run `./bin/start --oss --gke`
180
-
- DeployConjurEnterprise on Openshift, run `./bin/start --dap --current`
180
+
- DeploySecretsManager, Self-Hosted on Openshift, run `./bin/start --dap --current`
0 commit comments