Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixins issue # kubernetes-sigs#86

As per 
https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L53C1-L54

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L172

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L106-L110

The README.md file provides instructions for deploying the controller (https://github.com/kubernetes-sigs/secrets-store-sync-controller?tab=readme-ov-file#deploy-the-controller). However, there are discrepancies between the instructions and the actual outcomes of the commands.

Specifically, when executing the command: VERSION=e2e make docker-build
The resulting Docker image is named controller:e2e instead of secrets-store-sync-controller:e2e as stated in the documentation.
This inconsistency between the documentation and the actual behavior may lead to confusion for users attempting to deploy the controller.
  • Loading branch information
jayeshmahajan authored Sep 27, 2024
1 parent 1e6320f commit c5e9643
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ As the controller is still under development, the helm chart is not available in
```shell
VERSION=e2e make docker-build

kind load docker-image --name sync-controller secrets-store-sync-controller:e2e
kind load docker-image --name sync-controller controller:e2e
```

1. Configure the provider container
Expand Down Expand Up @@ -130,4 +130,4 @@ bats test/bats/e2e-provider-ssc.bats
-->

## Troubleshooting
The validating admission policies are available for k8s 1.27 and later. If you are using an older version of k8s, you may need to disable the validating admission policies by setting the `validatingAdmissionPolicies.applyPolicies` parameter to `false` in the `secret-sync-controller/secretsync/values.yaml` file.
The validating admission policies are available for k8s 1.27 and later. If you are using an older version of k8s, you may need to disable the validating admission policies by setting the `validatingAdmissionPolicies.applyPolicies` parameter to `false` in the `secret-sync-controller/secretsync/values.yaml` file.

0 comments on commit c5e9643

Please sign in to comment.