[DOC] Update external configuration to include DirectoryConfigProvider

[PaulRMellor]

Signed-off-by: prmellor pmellor@redhat.com

Type of change

Documentation

Updates the ExternalConfiguration schema reference section in the Using guide to describe how DirectoryConfigProvider can be used instead of FileConfigProvider

Checklist

Please go through this checklist and make sure all applicable tasks have been done

• Write tests
• Make sure all tests pass
• Update documentation
• Check RBAC rights for Kubernetes / OpenShift roles
• Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
• Reference relevant issue(s) and close them after merging
• Update CHANGELOG.md
• Supply screenshots for visual changes, such as Grafana dashboards

[strimzi-ci]

Can one of the admins verify this patch?

[scholzj]

There is nothing wrong per-se with the changes. I just wonder if readers will really understand the difference.

[scholzj]

I wonder if this would make it clear to the readers ... should we have an example for both?

[PaulRMellor]

@scholzj Yes. We can add examples for both.
Something like this?

Secret:

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
  labels:
    strimzi.io/kind: KafkaUser
    strimzi.io/cluster: my-cluster
type: Opaque
data:
  ca.crt: # Public key of the client CA
  user.crt: # User certificate that contains the public key of the user
  user.key: # Private key of the user
  user.p12: # PKCS #12 archive file for storing certificates and keys
  user.password: # Password for protecting the PKCS #12 archive file

Config for Kafka Connect:

  config:
    config.providers: directory
    config.providers.directory.class: org.apache.kafka.common.config.provider.DirectoryConfigProvider
  #...
  externalConfiguration:
    volumes:
      - name: connector-config
        secret:
          secretName: mysecret

Connector:

kind: KafkaConnector
metadata:
  name: my-source-connector
  labels:
    strimzi.io/cluster: my-connect-cluster
spec:
  class: io.debezium.connector.mysql.MySqlConnector
  tasksMax: 2
  config:
    security.protocol: SSL
    ssl.truststore.type: PEM
    ssl.truststore.location: "${directory:/opt/kafka/external-configuration/connector-config/ca.crt}"
    ssl.keystore.type: PEM
    ssl.keystore.location: ${directory:/opt/kafka/external-configuration/connector-config/user.key}"
    #...

[tombentley]

@PaulRMellor your ${directory:...} should looks like directory:dir:file, so I think you need to change the last / to a :. See the example in https://cwiki.apache.org/confluence/display/KAFKA/KIP-632%3A+Add+DirectoryConfigProvider

[PaulRMellor]

@tombentley Thanks Tom

[scholzj]

Yeah, that is a nice example.

[PaulRMellor]

Thanks. I've added the new example, so we have examples for both providers now. I'v shown the connector config for both.

[tombentley]

A couple of nits, but LGTM.