Skip to content

Commit

Permalink
#1299 menas configuration: secure schema registry
Browse files Browse the repository at this point in the history
  • Loading branch information
dk1844 committed Jun 30, 2020
1 parent c4be3ef commit 722088e
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 1 deletion.
26 changes: 26 additions & 0 deletions _data/menas-configuration_2_0_0.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
- name: menas.schemaRegistryBaseUrl
options:
- name: string with URL
description: 'Base Url to (secure) schema registry. E.g.:
<code>https://localhost:8081</code>'
- name: javax.net.ssl.trustStore
options:
- name: string path to JKS file
description: 'TrustStore file containing records of trusted certificates to connect to a secure schema registry.
E.g.: <code>/path/to/truststore.jks</code>'
- name: javax.net.ssl.trustStorePassword
options:
- name: string
description: 'Password for the file referenced in <code>javax.net.ssl.trustStore</code>. E.g.:
<code>password123</code>'
- name: javax.net.ssl.keyStore
options:
- name: string path to JKS file
description: 'KeyStore file containing records of private keys to connect to a secure schema registry.
E.g.: <code>/path/to/keystore.jks</code>'
- name: javax.net.ssl.keyStorePassword
options:
- name: string
description: 'Password for the file referenced in <code>javax.net.ssl.keyStore</code>. E.g.:
<code>password1234</code>'
7 changes: 6 additions & 1 deletion _docs/2.0.0/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,14 @@ This part of the documentations will show you how to use Enceladus, Menas as its

## Spark Jobs

- [Configuration]({{ docs_path }}/usage/config)

## Menas

- [Configuration]({{ docs_path }}/usage/menas-config)

## General

- [Configuration]({{ docs_path }}/usage/config)
- [How to run]({{ docs_path }}/usage/run)
- [\_INFO file]({{ docs_path }}/usage/info-file)
- [Schema]({{ docs_path }}/usage/schema)
Expand Down
35 changes: 35 additions & 0 deletions _docs/2.0.0/usage/menas-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: docs
title: Usage - Menas Configuration
version: '2.0.0'
categories:
- '2.0.0'
- usage
---
## Table Of Contents
<!-- toc -->
- [Table Of Contents](#table-of-contents)
- [Intro](#intro)
- [General options](#general-options)
<!-- tocstop -->

## Intro

This page describes the usage of configuration of _Menas_.
This page describes the configuration values stored in `menas`'s `application.properties` (or its
[template][app-props-template]).

## General options

{% include config_options.html file="menas-configuration_2_0_0" %}

Note, that
- `menas.schemaRegistryBaseUrl` may not be present (in that case, the option to load schema from a schema registry
by subject name will disappear in the Menas UI)
- specifying `javax.net.ssl.{trustStore|keyStore}` (and the passwords) is usually both necessary to successfully load
a schema file from a secure schema registry, but this setting will be used by the by-URL loading as well
(if supported by webserver reached)


[readme]: https://github.com/AbsaOSS/enceladus/blob/master/README.md
[app-props-template]: https://github.com/AbsaOSS/enceladus/blob/master/menas/src/main/resources/application.properties.template
5 changes: 5 additions & 0 deletions _docs/usage/menas-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: redirect
title: Usage - Menas Configuration
permalink: /docs/usage/menas-config
---

0 comments on commit 722088e

Please sign in to comment.