diff --git a/docs/devel/dns01-providers.rst b/docs/devel/dns01-providers.rst index e489f20bc..5b7c53a83 100644 --- a/docs/devel/dns01-providers.rst +++ b/docs/devel/dns01-providers.rst @@ -19,14 +19,22 @@ Steps to add a ``FooDNS`` DNS-01 provider: cert-manager does not use environment variables for internal configuration, so calls to this package should not be required. 3. Add unit test coverage for this package. -4. Add coverage for the provider to ``pkg/issuer/acme/dns/dns_test.go``. -5. Add your provider configuration types to the API (located in ``pkg/apis/certmanager/v1alpha1/types.go``) and regenerate code (run ``./hack/update-codegen.sh``). -6. Register the provider in ``pkg/issuer/acme/dns``. +4. Add your provider configuration types to the API (located in ``pkg/apis/certmanager/v1alpha1/types.go``) and regenerate code (run ``./hack/update-codegen.sh``). + New API types should have an associated short documentation string, + which is added to the reference API documentation (run ``./hack/update-reference-docs-dockerized.sh`` to update the API documentation). +5. Register the provider in ``pkg/issuer/acme/dns``: + + - The constructor for the provider needs adding to ``dnsProviderConstructors``, + - ``solverForIssuerProvider`` must be updated to handle retrieving any information for the new provider (for example, fetching credentials from a secret) + and constructing a new instance of the provider. + +6. Add coverage for the provider to ``pkg/issuer/acme/dns/dns_test.go``. 7. Add example configuration for the new provider to ``docs/reference/issuers/acme/dns01.rst``. -8. Run conformance tests for the new provider. (TODO: actually build these) -9. Submit your new provider to cert-manager, attaching the conformance test results to the pull request. - - + The more information here the better, + this example and corresponding documentation should inform users how to use and configure this backend, + as well as mentioning any nuances with using this particular provider. +8. Test your provider out against a real account, and make sure you can issue a Certificate. +9. Submit your new provider to cert-manager! Things to watch out for: