guilhem / freeipa-issuer

A cert-manager external issuer for FreeIPA
Apache License 2.0
31 stars 14 forks source link

Incomplete Documentation #4

Closed StefanAbl closed 3 years ago

StefanAbl commented 3 years ago

First of all thanks for piece of software. While setting this up for testing I encountered some issues which could be avoided with more documentation.

  1. Declare Kustomize as a dependency, as this not obvious for someone who is completely new to kubernetes (like me)
  2. The Issuer sample in the Readme seems to be missing a field error: error validating "issuer.yml": error validating data: ValidationError(Issuer.spec): missing required field "ignoreError" in org.freeipa.certmanager.v1beta1.Issuer.spec; if you choose to ignore these errors, turn validation off with --validate=false
  3. In the Prerequisite section you should add that the Kubernetes workers on which the controller pod will run need to be joined into the FreeIPA realm because otherwise the certificate is not recognized.
  4. For me having the password and username base64 encoded did not work, only plain text
  5. The controller docker image is not in a registry and has to be build locally, maybe pushing it to Docker Hub would be better
  6. Add to the documentation that for certificate requests the group option has to be set for cert-manager to find the FreeIPA issuer

I hope some of these points can be addressed in the Readme, as I think this would make it easier to setup for new users.

Edit: Added point 6