Merge branch 'development' into 'master'

Development

See merge request !22

Dockerfile

+ARG BASE_REGISTRY=registry1.dso.mil
+ARG BASE_IMAGE=ironbank/redhat/openjdk/openjdk11
+ARG BASE_TAG=1.11
+
+FROM tchiotludo/akhq:0.18.0 as base
+
+FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG}
+
+WORKDIR /app
+
+USER 0
+
+COPY --from=base /app .
+COPY --from=base /usr/local/bin/ /usr/local/bin/
+COPY ./config .
+COPY ./scripts/akhq .
+
+ENV MICRONAUT_CONFIG_FILES=/app/application.yml
+
+RUN chown -R 1001 /app
+
+RUN dnf upgrade -y && \
+    dnf clean all && \
+    rm -rf /var/cache/dnf && \
+    chmod +x /app/akhq
+
+ENTRYPOINT ["docker-entrypoint.sh"]
+
+CMD ["./akhq"]
+
+USER 1001
+
+HEALTHCHECK NONE

LICENSE

+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
\ No newline at end of file

config/application.yml

+micronaut:
+  security:
+    enabled: true
+    # Ldap authentificaton configuration
+    ldap:
+      default:
+        enabled: true
+        context:
+          server: 'ldap://ldap.forumsys.com:389'
+          managerDn: 'cn=read-only-admin,dc=example,dc=com'
+          managerPassword:
+        search:
+          base: "dc=example,dc=com"
+        groups:
+          enabled: true
+          base: "dc=example,dc=com"
+    # OIDC authentification configuration
+    oauth2:
+      enabled: true
+      clients:
+        oidc:
+          client-id: "<client-id>"
+          client-secret: "<client-secret>"
+          openid:
+            issuer: "<issuer-url>"
+    token:
+      jwt:
+        signatures:
+          secret:
+            generator:
+              secret:
+
+  server:
+    context-path: "" # if behind a reverse proxy, path to akhq without trailing slash (optional). Example: akhq is
+                     # behind a reverse proxy with url http://my-server/akhq, set base-path: "/akhq".
+                     # Not needed if you're behind a reverse proxy with subdomain http://akhq.my-server/
+akhq:
+  server:
+    access-log: # Access log configuration (optional)
+      enabled: true # true by default
+      name: org.akhq.log.access # Logger name
+      format: "[Date: {}] [Duration: {} ms] [Url: {} {}] [Status: {}] [Ip: {}] [User: {}]" # Logger format
+
+  # default kafka properties for each clients, available for admin / producer / consumer (optional)
+  clients-defaults:
+    consumer:
+      properties:
+        isolation.level: read_committed
+
+  # list of kafka cluster available for akhq
+  connections:
+    my-cluster-plain-text: # url friendly name for the cluster (letter, number, _, -, ... dot are not allowed here)
+      properties: # standard kafka properties (optional)
+        bootstrap.servers: "kafka:9092"
+      schema-registry:
+        url: "http://schema-registry:8085" # schema registry url (optional)
+        type: "confluent" # schema registry type (optional). Supported types are "confluent" (default) or "tibco"
+        # Basic Auth user / pass
+        basic-auth-username: ${UN}
+        basic-auth-password: ${PW}
+        properties: # standard kafka properties (optional)
+          ssl.protocol: TLS
+      connect:
+        - name: connect-1
+          url: "http://connect:8083"
+          # Basic Auth user / pass (optional)
+          basic-auth-username: ${UN}
+          basic-auth-password: ${PW}
+          # ssl store configuration (optional)
+          ssl-trust-store: /app/truststore.jks
+          ssl-trust-store-password: ${PW}
+          ssl-key-store: /app/truststore.jks
+          ssl-key-store-password: ${PW}
+        - name: connect-2
+          url: "http://connect:8084"
+          # Basic Auth user / pass (optional)
+          basic-auth-username: ${UN}
+          basic-auth-password: ${PW}
+          # ssl store configuration (optional)
+          ssl-trust-store: /app/truststore.jks
+          ssl-trust-store-password: ${PW}
+          ssl-key-store: /app/truststore.jks
+          ssl-key-store-password: ${PW}
+      deserialization:
+        protobuf:
+          # (optional) if descriptor-file properties are used
+          descriptors-folder: "/app/protobuf_desc"
+          topics-mapping:
+            - topic-regex: "album.*"
+              descriptor-file-base64: "" #Base64
+              value-message-type: "Album"
+            - topic-regex: "film.*"
+              descriptor-file-base64: "" #Base64
+              value-message-type: "Film"
+            - topic-regex: "test.*"
+              descriptor-file: "other.desc"
+              key-message-type: "Row"
+              value-message-type: "Envelope"
+      # Ui Cluster Options (optional)
+      ui-options:
+        topic:
+          default-view: ALL  # default list view (ALL, HIDE_INTERNAL, HIDE_INTERNAL_STREAM, HIDE_STREAM). Overrides default
+          skip-consumer-groups: false # Skip loading consumer group information when showing topics. Overrides default
+          skip-last-record: true  # Skip loading last record date information when showing topics.  Overrides default
+        topic-data:
+          sort: NEWEST # default sort order (OLDEST, NEWEST) (default: OLDEST).  Overrides default
+
+    my-cluster-ssl:
+      properties:
+        bootstrap.servers: "kafka:9093"
+        security.protocol: SSL
+        ssl.truststore.location: /app/truststore.jks
+        ssl.truststore.password: ${PW}
+        ssl.keystore.location: /app/keystore.jks
+        ssl.keystore.password: ${PW}
+        ssl.key.password: ${PW}
+
+    my-cluster-sasl:
+      properties:
+        bootstrap.servers: "kafka:9094"
+        security.protocol: SASL_SSL
+        sasl.mechanism: SCRAM-SHA-256
+        sasl.jaas.config: org.apache.kafka.common.security.scram.ScramLoginModule required username="${UN}" password="${PW}";
+        ssl.truststore.location: /app/truststore.jks
+        ssl.truststore.password: ${PW}
+        ssl.keystore.location: /app/keystore.jks
+        ssl.keystore.password: ${PW}
+        ssl.key.password: ${PW}
+
+  pagination:
+    page-size: 25 # number of elements per page (default : 25)
+    threads: 16 # Number of parallel threads to resolve page
+
+  # Topic list display options (optional)
+  topic:
+    retention: 172800000 # default retention period when creating topic
+    partition: 3 #  default number of partition when creating topic
+    replication: 3 # default number of replicas when creating topic
+    internal-regexps: # list of regexp to be considered as internal (internal topic can't be deleted or updated)
+      - "^_.*$"
+      - "^.*_schemas$"
+      - "^.*connect-config$"
+      - "^.*connect-offsets$1"
+      - "^.*connect-status$"
+    stream-regexps: # list of regexp to be considered as internal stream topic
+      - "^.*-changelog$"
+      - "^.*-repartition$"
+      - "^.*-rekey$"
+    skip-consumer-groups: false # Skip loading consumer group information when showing topics
+    skip-last-record: false # Skip loading last record date information when showing topics
+
+  # Topic display data options (optional)
+  topic-data:
+    size: 50 # max record per page (default: 50)
+    poll-timeout: 1000 # The time, in milliseconds, spent waiting in poll if data is not available in the buffer.
+
+  # Ui Global Options (optional)
+  ui-options:
+    topic:
+      default-view: ALL  # default list view (ALL, HIDE_INTERNAL, HIDE_INTERNAL_STREAM, HIDE_STREAM). Overrides default
+      skip-consumer-groups: false # Skip loading consumer group information when showing topics. Overrides default
+      skip-last-record: true  # Skip loading last record date information when showing topics.  Overrides default
+    topic-data:
+      sort: NEWEST # default sort order (OLDEST, NEWEST) (default: OLDEST).  Overrides default
+
+  # Auth & Roles (optional)
+  security:
+    default-group: admin # Default groups for all the user even unlogged user
+    # Groups definition
+    groups:
+      admin: # unique key
+        name: admin # Group name
+        roles:  # roles for the group
+          - topic/read
+          - topic/insert
+          - topic/delete
+          - topic/config/update
+          - node/read
+          - node/config/update
+          - topic/data/read
+          - topic/data/insert
+          - topic/data/delete
+          - group/read
+          - group/delete
+          - group/offsets/update
+          - registry/read
+          - registry/insert
+          - registry/update
+          - registry/delete
+          - registry/version/delete
+          - acls/read
+          - connect/read
+          - connect/insert
+          - connect/update
+          - connect/delete
+          - connect/state/update
+        attributes:
+          # Regexp to filter topic available for group
+          topics-filter-regexp: "test.*"
+          # Regexp to filter connect configs visible for group
+          connects-filter-regexp: "^test.*$"
+          # Regexp to filter consumer groups visible for group
+          consumer-groups-filter-regexp: "consumer.*"
+      topic-reader: # unique key
+        name: topic-reader # Other group
+        roles:
+          - topic/read
+        attributes:
+          topics-filter-regexp: "test\\.reader.*"
+
+    # Basic auth configuration
+    basic-auth:
+      - username: ${UN} # Username
+        password: ${PW} # Password in sha256
+        groups: # Groups for the user
+          - admin
+          - topic-reader
+
+    # Ldap Groups configuration (when using ldap)
+    ldap:
+      default-group: topic-reader
+      groups:
+        - name: group-ldap-1
+          groups: # Akhq groups list
+            - topic-reader
+        - name: group-ldap-2
+          groups:
+            - admin
+      users:
+        - username: ${UN} # ldap user id
+          groups: # Akhq groups list
+            - topic-reader
+        - username: ${UN}
+          groups:
+            - admin
+
+    # OIDC configuration
+    oidc:
+      enabled: true
+      providers:
+        oidc:
+          label: "Login with OIDC"
+          username-field: ${UN}
+          groups-field: roles
+          default-group: topic-reader
+          groups:
+            - name: oidc-admin-group
+              groups:
+                - admin
+          users:
+            - username: ${UN}
+              groups:
+                - admin

hardening_manifest.yaml

+---
+apiVersion: v1
+
+# The repository name in registry1, excluding /ironbank/
+name: "opensource/tchiotludo/akhq"
+
+# List of tags to push for the repository in registry1
+# The most specific version should be the first tag and will be shown
+# on ironbank.dsop.io
+tags:
+- "0.18.0"
+- "latest"
+
+# Build args passed to Dockerfile ARGs
+args:
+  BASE_IMAGE: "redhat/openjdk/openjdk11"
+  BASE_TAG: "1.11"
+
+# Docker image labels
+labels:
+  org.opencontainers.image.title: "akhq"
+  ## Human-readable description of the software packaged in the image
+  org.opencontainers.image.description: "AKHQ was previously Kafka GUI for Apache Kafka to manage topics, topics data, consumers group and schema registry"
+  ## License(s) under which contained software is distributed
+  org.opencontainers.image.licenses: "Apache License 2.0"
+  ## URL to find more information on the image
+  org.opencontainers.image.url: "https://hub.docker.com/r/tchiotludo/akhq"
+  ## Name of the distributing entity, organization or individual
+  org.opencontainers.image.vendor: "opensource"
+  org.opencontainers.image.version: "0.18.0"
+  ## Keywords to help with search (ex. "cicd,gitops,golang")
+  mil.dso.ironbank.image.keywords: "kafka-dashboard,dataflow,processing,akhq"
+  ## This value can be "opensource" or "commercial"
+  mil.dso.ironbank.image.type: "opensource"
+  ## Product the image belongs to for grouping multiple images
+  mil.dso.ironbank.product.name: "akhq"
+
+# List of resources to make available to the offline build context
+resources:
+- tag: tchiotludo/akhq:0.18.0
+  url: docker://docker.io/tchiotludo/akhq@sha256:c977e6dfe9d3a290eb16530e3b8ad0c251076a5997cb9867b635d1727799cbf5
+
+# List of project maintainers
+maintainers:
+- name: "Jacob Rohlman"
+  username: "jacob.rohlman"
+  email: "jacob.rohlman@us.af.mil"
+  cht_member: true 

renovate.json

+{
+  "assignees": [
+    "@jacob.rohlman"
+  ],
+  "baseBranches": [
+    "development"
+  ],
+  "automerge": true,
+  "gitLabAutomerge": true,
+  "regexManagers": [
+    {
+      "fileMatch": [
+        "^hardening_manifest.yaml$"
+      ],
+      "matchStrings": [
+        "org\\.opencontainers\\.image\\.version:\\s+\"(?<currentValue>.+?)\""
+      ],
+      "depNameTemplate": "tchiotludo/akhq",
+      "datasourceTemplate": "docker"
+    },
+    {
+      "fileMatch": [
+        "^hardening_manifest.yaml$"
+      ],
+      "matchStrings": [
+        "tags:\\s+-\\s+\"(?<currentValue>.+?)\""
+      ],
+      "depNameTemplate": "tchiotludo/akhq",
+      "datasourceTemplate": "docker"
+    }
+  ]
+}
+

scripts/akhq

+#!/usr/bin/env sh
+
+# Read user-defined JVM options from jvm.options file
+JVM_OPTS_FILE=${JVM_OPTS_FILE:-/app/jvm.options}
+for JVM_OPT in `grep "^-" ${JVM_OPTS_FILE}`
+do
+  JAVA_OPTS="${JAVA_OPTS} ${JVM_OPT}"
+done
+
+java ${JAVA_OPTS} -cp /app/akhq.jar:${CLASSPATH} org.akhq.App
\ No newline at end of file

scripts/docker-entrypoint.sh

+ #!/usr/bin/env sh
+
+set -e
+
+if [ "${AKHQ_CONFIGURATION}" ]; then
+    echo "${AKHQ_CONFIGURATION}" > /app/application.yml
+fi
+
+exec "$@"
\ No newline at end of file