Skip to content

Commit

Permalink
Move LDAP options to admin guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Markus Napp committed Oct 8, 2018
1 parent 675d4b2 commit 148a6fc
Showing 1 changed file with 1 addition and 272 deletions.
273 changes: 1 addition & 272 deletions xml/quick_configuration.xml
View file
Expand Up @@ -86,276 +86,5 @@
</varlistentry>
</variablelist>
</sect1>
<sect1 xml:id="installation.velumsettings">
<title>&dashboard; Settings</title>

<para>
Configuration within &dashboard; after bootstrap is available under the Settings
page. Registries, External Authentication and some &kube; options are
configurable:
</para>

<sect2>
<title>LDAP Connector Settings</title>
<note>
<title>LDAP Anonymous Binding</title>
<para>
Anonymous binding is available, if allowed by the LDAP server.
</para>
</note>
<para>
Configure the cluster to authenticate &dashboard; and &kube; users against a
pre-existing Lightweight Directory Access Protocol (LDAP)
server and use <link xlink:href="https://ldap.com/ldap-filters/">LDAP Filters</link>
to select the scope of users that will be permitted access.
</para>

<para>
Access the LDAP configuration settings under <guimenu>Settings
&rarr; EXTERNAL AUTHENTICATION &rarr; LDAP Connectors</guimenu>.
</para>
<para>
Click on <guimenu>Add LDAP connector</guimenu> to add a new connector.
</para>
<informalfigure>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="velum_settings_ldap.png" width="100%"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="velum_settings_ldap.png" width="100%"/>
</imageobject>
</mediaobject>
</informalfigure>
<variablelist>
<varlistentry>
<term>Name</term>
<listitem>
<para>
Name for the LDAP connection.
</para>
</listitem>
</varlistentry>
</variablelist>
<sect3>
<title>Server</title>
<para>
Basic settings for the LDAP server host.
</para>
<variablelist>
<varlistentry>
<term>Host</term>
<listitem>
<para>
Hostname of the LDAP server used for this connection.
</para>
<note>
<title>Provide the hostname as FQDN</title>
<para>
The <guimenu>Host</guimenu> field must use a Fully Qualified Domain
Name, as IP address is not allowed with TLS.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>Port</term>
<listitem>
<para>
<!-- FIXME What's the default here? -->
Connection to LDAP server requires TLS via StartTLS on port
<literal>636</literal> or SimpleTLS or port <literal>389</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>StartTLS</term>
<listitem>
<para>
Choose whether you wish to use StartTLS for authentication or not.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Certificate</term>
<listitem>
<para>
The <guimenu>Certificate</guimenu> field must be a Base64-encoded PEM
key.
</para>
<note>
<title>Remove the enclosing lines</title>
<para>
You must enter the certificate body only. This means only the content
between the <literal>-----BEGIN CERTIFICATE-----</literal> and
<literal>-----END CERTIFICATE-----</literal> lines but not those lines
themselves.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3>
<title>Authentication</title>
<variablelist>
<varlistentry>
<term>Anonymous</term>
<listitem>
<para>
Selects if you wish to perform an anonymous bind with the LDAP server.
If set to <guimenu>False</guimenu> you must provide a
<guimenu>DN</guimenu> and a <guimenu>Password</guimenu>. The latter two
are hidden when the slider is set to <guimenu>True</guimenu>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DN</term>
<listitem>
<para>
Distinguished Name used for the authentication.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Password</term>
<listitem>
<para>
Password for the <guimenu>DN</guimenu> doing the authentication.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3>
<title>User Search</title>
<para>
<!-- FIXME Add description of what this set of fields does -->
</para>
<variablelist>
<varlistentry>
<term>Username Prompt</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Base DN</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filter</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3>
<title>User Attribute Map</title>
<para>
<!-- FIXME Add description of what this set of fields does -->
</para>
<variablelist>
<varlistentry>
<term>Username</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ID</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Email</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Name</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3>
<title>Group Search</title>
<para>
<!-- FIXME Add description of what this set of fields does -->
</para>
<variablelist>
<varlistentry>
<term>Base DN</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filter</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3>
<title>Group Attribute Map</title>
<para>
<!-- FIXME Add description of what this set of fields does -->
</para>
<variablelist>
<varlistentry>
<term>User</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Group</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Name</term>
<listitem>
<para>
<!-- FIXME Fill in description -->
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>

</chapter>

0 comments on commit 148a6fc

Please sign in to comment.