`_.
+
+ To install it, use: :code:`ansible-galaxy collection install middleware\_automation.keycloak`.
+
+ To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client`.
+
+.. version_added
+
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows the administration of Keycloak clients via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
+- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ https://www.keycloak.org/docs-api/8.0/rest-api/index.html\ . Aliases are provided so camelCased versions can be used as well.
+- The Keycloak API does not always sanity check inputs e.g. you can set SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. If you do not specify a setting, usually a sensible default is chosen.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-admin_url:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-adminurl:
+
+ .. rst-class:: ansible-option-title
+
+ **admin_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: adminUrl`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ URL to the admin interface of the client. This is 'adminUrl' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-always_display_in_console:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-alwaysdisplayinconsole:
+
+ .. rst-class:: ansible-option-title
+
+ **always_display_in_console**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: alwaysDisplayInConsole`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.7.0`
+
+
+ .. raw:: html
+
+
+
+ Whether or not to display this client in account console, even if the user does not have an active session.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes:
+
+ .. rst-class:: ansible-option-title
+
+ **attributes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ A dict of further attributes for this client. This can contain various configuration settings; an example is given in the examples section. While an exhaustive list of permissible options is not available; possible options as of Keycloak 3.4 are listed below. The Keycloak API does not validate whether a given option is appropriate for the protocol used; if specified anyway, Keycloak will simply not use it.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/jwks.url:
+
+ .. rst-class:: ansible-option-title
+
+ **jwks.url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For OpenID-Connect clients, URL where client keys in JWK are stored.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/jwt.credential.certificate:
+
+ .. rst-class:: ansible-option-title
+
+ **jwt.credential.certificate**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For OpenID-Connect clients, client certificate for validating JWT issued by client and signed by its key, base64-encoded.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/request.object.signature.alg:
+
+ .. rst-class:: ansible-option-title
+
+ **request.object.signature.alg**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For OpenID-Connect clients, JWA algorithm which the client needs to use when sending OIDC request object. One of \ :literal:`any`\ , \ :literal:`none`\ , \ :literal:`RS256`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.authnstatement:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.authnstatement**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, boolean specifying whether or not a statement containing method and timestamp should be included in the login response.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.client.signature:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.client.signature**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, boolean specifying whether a client signature is required and validated.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.encrypt:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.encrypt**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Boolean specifying whether SAML assertions should be encrypted with the client's public key.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.force.post.binding:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.force.post.binding**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, boolean specifying whether always to use POST binding for responses.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.onetimeuse.condition:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.onetimeuse.condition**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, boolean specifying whether a OneTimeUse condition should be included in login responses.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.server.signature:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.server.signature**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Boolean specifying whether SAML documents should be signed by the realm.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.server.signature.keyinfo.ext:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.server.signature.keyinfo.ext**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, boolean specifying whether REDIRECT signing key lookup should be optimized through inclusion of the signing key id in the SAML Extensions element.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.signature.algorithm:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.signature.algorithm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Signature algorithm used to sign SAML documents. One of \ :literal:`RSA\_SHA256`\ , \ :literal:`RSA\_SHA1`\ , \ :literal:`RSA\_SHA512`\ , or \ :literal:`DSA\_SHA1`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.signing.certificate:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.signing.certificate**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML signing key certificate, base64-encoded.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml.signing.private.key:
+
+ .. rst-class:: ansible-option-title
+
+ **saml.signing.private.key**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML signing key private key, base64-encoded.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_assertion_consumer_url_post:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_assertion_consumer_url_post**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML POST Binding URL for the client's assertion consumer service (login responses).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_assertion_consumer_url_redirect:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_assertion_consumer_url_redirect**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML Redirect Binding URL for the client's assertion consumer service (login responses).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_force_name_id_format:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_force_name_id_format**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, Boolean specifying whether to ignore requested NameID subject format and using the configured one instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_name_id_format:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_name_id_format**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For SAML clients, the NameID format to use (one of \ :literal:`username`\ , \ :literal:`email`\ , \ :literal:`transient`\ , or \ :literal:`persistent`\ )
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_signature_canonicalization_method:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_signature_canonicalization_method**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML signature canonicalization method. This is one of four values, namely \ :literal:`http://www.w3.org/2001/10/xml-exc-c14n#`\ for EXCLUSIVE, \ :literal:`http://www.w3.org/2001/10/xml-exc-c14n#WithComments`\ for EXCLUSIVE\_WITH\_COMMENTS, \ :literal:`http://www.w3.org/TR/2001/REC-xml-c14n-20010315`\ for INCLUSIVE, and \ :literal:`http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments`\ for INCLUSIVE\_WITH\_COMMENTS.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_single_logout_service_url_post:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_single_logout_service_url_post**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML POST binding url for the client's single logout service.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/saml_single_logout_service_url_redirect:
+
+ .. rst-class:: ansible-option-title
+
+ **saml_single_logout_service_url_redirect**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ SAML redirect binding url for the client's single logout service.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/use.jwks.url:
+
+ .. rst-class:: ansible-option-title
+
+ **use.jwks.url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For OpenID-Connect clients, boolean specifying whether to use a JWKS URL to obtain client public keys.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-attributes/user.info.response.signature.alg:
+
+ .. rst-class:: ansible-option-title
+
+ **user.info.response.signature.alg**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For OpenID-Connect clients, JWA algorithm for signed UserInfo-endpoint responses. One of \ :literal:`RS256`\ or \ :literal:`unsigned`\ .
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-auth_client_id:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_client_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ OpenID Connect \ :emphasis:`client\_id`\ to authenticate to the API with.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin-cli"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-auth_client_secret:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_client_secret**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Client Secret to use in conjunction with \ :emphasis:`auth\_client\_id`\ (if required).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-auth_keycloak_url:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-url:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_keycloak_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: url`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL to the Keycloak instance.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-auth_password:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: password`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password to authenticate for API access with.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-auth_realm:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Keycloak realm name to authenticate to for API access.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-auth_username:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: username`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Username to authenticate for API access with.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-authentication_flow_binding_overrides:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-authenticationflowbindingoverrides:
+
+ .. rst-class:: ansible-option-title
+
+ **authentication_flow_binding_overrides**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: authenticationFlowBindingOverrides`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.4.0`
+
+
+ .. raw:: html
+
+
+
+ Override realm authentication flow bindings.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-authorization_services_enabled:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-authorizationservicesenabled:
+
+ .. rst-class:: ansible-option-title
+
+ **authorization_services_enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: authorizationServicesEnabled`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Are authorization services enabled for this client or not (OpenID connect). This is 'authorizationServicesEnabled' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-authorization_settings:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-authorizationsettings:
+
+ .. rst-class:: ansible-option-title
+
+ **authorization_settings**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: authorizationSettings`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ a data structure defining the authorization settings for this client. For reference, please see the Keycloak API docs at \ https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_resourceserverrepresentation\ . This is 'authorizationSettings' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-base_url:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-baseurl:
+
+ .. rst-class:: ansible-option-title
+
+ **base_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: baseUrl`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Default URL to use when the auth server needs to redirect or link back to the client This is 'baseUrl' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-bearer_only:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-beareronly:
+
+ .. rst-class:: ansible-option-title
+
+ **bearer_only**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: bearerOnly`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ The access type of this client is bearer-only. This is 'bearerOnly' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-client_authenticator_type:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-clientauthenticatortype:
+
+ .. rst-class:: ansible-option-title
+
+ **client_authenticator_type**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: clientAuthenticatorType`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ How do clients authenticate with the auth server? Either \ :literal:`client-secret`\ or \ :literal:`client-jwt`\ can be chosen. When using \ :literal:`client-secret`\ , the module parameter \ :emphasis:`secret`\ can set it, while for \ :literal:`client-jwt`\ , you can use the keys \ :literal:`use.jwks.url`\ , \ :literal:`jwks.url`\ , and \ :literal:`jwt.credential.certificate`\ in the \ :emphasis:`attributes`\ module parameter to configure its behavior. This is 'clientAuthenticatorType' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"client-secret"`
+ - :ansible-option-choices-entry:`"client-jwt"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-client_id:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-clientid:
+
+ .. rst-class:: ansible-option-title
+
+ **client_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: clientId`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Client id of client to be worked on. This is usually an alphanumeric name chosen by you. Either this or \ :emphasis:`id`\ is required. If you specify both, \ :emphasis:`id`\ takes precedence. This is 'clientId' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-client_template:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-clienttemplate:
+
+ .. rst-class:: ansible-option-title
+
+ **client_template**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: clientTemplate`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Client template to use for this client. If it does not exist this field will silently be dropped. This is 'clientTemplate' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-connection_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **connection_timeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.5.0`
+
+
+ .. raw:: html
+
+
+
+ Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-consent_required:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-consentrequired:
+
+ .. rst-class:: ansible-option-title
+
+ **consent_required**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: consentRequired`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ If enabled, users have to consent to client access. This is 'consentRequired' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-default_client_scopes:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-defaultclientscopes:
+
+ .. rst-class:: ansible-option-title
+
+ **default_client_scopes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: defaultClientScopes`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.7.0`
+
+
+ .. raw:: html
+
+
+
+ List of default client scopes.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-default_roles:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-defaultroles:
+
+ .. rst-class:: ansible-option-title
+
+ **default_roles**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: defaultRoles`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ list of default roles for this client. If the client roles referenced do not exist yet, they will be created. This is 'defaultRoles' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Description of the client in Keycloak.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-direct_access_grants_enabled:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-directaccessgrantsenabled:
+
+ .. rst-class:: ansible-option-title
+
+ **direct_access_grants_enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: directAccessGrantsEnabled`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Are direct access grants enabled for this client or not (OpenID connect). This is 'directAccessGrantsEnabled' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-enabled:
+
+ .. rst-class:: ansible-option-title
+
+ **enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Is this client enabled or not?
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-frontchannel_logout:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-frontchannellogout:
+
+ .. rst-class:: ansible-option-title
+
+ **frontchannel_logout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: frontchannelLogout`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Is frontchannel logout enabled for this client or not. This is 'frontchannelLogout' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-full_scope_allowed:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-fullscopeallowed:
+
+ .. rst-class:: ansible-option-title
+
+ **full_scope_allowed**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: fullScopeAllowed`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Is the "Full Scope Allowed" feature set for this client or not. This is 'fullScopeAllowed' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-http_agent:
+
+ .. rst-class:: ansible-option-title
+
+ **http_agent**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 5.4.0`
+
+
+ .. raw:: html
+
+
+
+ Configures the HTTP User-Agent header.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"Ansible"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Id of client to be worked on. This is usually an UUID. Either this or \ :emphasis:`client\_id`\ is required. If you specify both, this takes precedence.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-implicit_flow_enabled:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-implicitflowenabled:
+
+ .. rst-class:: ansible-option-title
+
+ **implicit_flow_enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: implicitFlowEnabled`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Enable implicit flow for this client or not (OpenID connect). This is 'implicitFlowEnabled' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of the client (this is not the same as \ :emphasis:`client\_id`\ ).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-node_re_registration_timeout:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-nodereregistrationtimeout:
+
+ .. rst-class:: ansible-option-title
+
+ **node_re_registration_timeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: nodeReRegistrationTimeout`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Cluster node re-registration timeout for this client. This is 'nodeReRegistrationTimeout' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-not_before:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-notbefore:
+
+ .. rst-class:: ansible-option-title
+
+ **not_before**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: notBefore`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Revoke any tokens issued before this date for this client (this is a UNIX timestamp). This is 'notBefore' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-optional_client_scopes:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-optionalclientscopes:
+
+ .. rst-class:: ansible-option-title
+
+ **optional_client_scopes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: optionalClientScopes`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.7.0`
+
+
+ .. raw:: html
+
+
+
+ List of optional client scopes.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol:
+
+ .. rst-class:: ansible-option-title
+
+ **protocol**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Type of client (either \ :literal:`openid-connect`\ or \ :literal:`saml`\ .
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"openid-connect"`
+ - :ansible-option-choices-entry:`"saml"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers:
+
+ .. rst-class:: ansible-option-title
+
+ **protocol_mappers**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: protocolMappers`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ a list of dicts defining protocol mappers for this client. This is 'protocolMappers' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/config:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/config:
+
+ .. rst-class:: ansible-option-title
+
+ **config**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of \ :emphasis:`protocolMapper`\ and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the \ :emphasis:`existing`\ field.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/consentrequired:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/consentrequired:
+
+ .. rst-class:: ansible-option-title
+
+ **consentRequired**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Specifies whether a user needs to provide consent to a client for this mapper to be active.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/consenttext:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/consenttext:
+
+ .. rst-class:: ansible-option-title
+
+ **consentText**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The human-readable name of the consent the user is presented to accept.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/id:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Usually a UUID specifying the internal ID of this protocol mapper instance.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/name:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of this protocol mapper.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/protocol:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/protocol:
+
+ .. rst-class:: ansible-option-title
+
+ **protocol**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ This is either \ :literal:`openid-connect`\ or \ :literal:`saml`\ , this specifies for which protocol this protocol mapper. is active.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"openid-connect"`
+ - :ansible-option-choices-entry:`"saml"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocol_mappers/protocolmapper:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-protocolmappers/protocolmapper:
+
+ .. rst-class:: ansible-option-title
+
+ **protocolMapper**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least
+
+ \ :literal:`docker-v2-allow-all-mapper`\
+
+ \ :literal:`oidc-address-mapper`\
+
+ \ :literal:`oidc-full-name-mapper`\
+
+ \ :literal:`oidc-group-membership-mapper`\
+
+ \ :literal:`oidc-hardcoded-claim-mapper`\
+
+ \ :literal:`oidc-hardcoded-role-mapper`\
+
+ \ :literal:`oidc-role-name-mapper`\
+
+ \ :literal:`oidc-script-based-protocol-mapper`\
+
+ \ :literal:`oidc-sha256-pairwise-sub-mapper`\
+
+ \ :literal:`oidc-usermodel-attribute-mapper`\
+
+ \ :literal:`oidc-usermodel-client-role-mapper`\
+
+ \ :literal:`oidc-usermodel-property-mapper`\
+
+ \ :literal:`oidc-usermodel-realm-role-mapper`\
+
+ \ :literal:`oidc-usersessionmodel-note-mapper`\
+
+ \ :literal:`saml-group-membership-mapper`\
+
+ \ :literal:`saml-hardcode-attribute-mapper`\
+
+ \ :literal:`saml-hardcode-role-mapper`\
+
+ \ :literal:`saml-role-list-mapper`\
+
+ \ :literal:`saml-role-name-mapper`\
+
+ \ :literal:`saml-user-attribute-mapper`\
+
+ \ :literal:`saml-user-property-mapper`\
+
+ \ :literal:`saml-user-session-note-mapper`\
+
+ An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -\> Providers and looking under 'protocol-mapper'.
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-public_client:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-publicclient:
+
+ .. rst-class:: ansible-option-title
+
+ **public_client**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: publicClient`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Is the access type for this client public or not. This is 'publicClient' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-realm:
+
+ .. rst-class:: ansible-option-title
+
+ **realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The realm to create the client in.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"master"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-redirect_uris:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-redirecturis:
+
+ .. rst-class:: ansible-option-title
+
+ **redirect_uris**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: redirectUris`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ Acceptable redirect URIs for this client. This is 'redirectUris' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-registered_nodes:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-registerednodes:
+
+ .. rst-class:: ansible-option-title
+
+ **registered_nodes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: registeredNodes`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ dict of registered cluster nodes (with \ :literal:`nodename`\ as the key and last registration time as the value). This is 'registeredNodes' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-registration_access_token:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-registrationaccesstoken:
+
+ .. rst-class:: ansible-option-title
+
+ **registration_access_token**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: registrationAccessToken`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The registration access token provides access for clients to the client registration service. This is 'registrationAccessToken' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-root_url:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-rooturl:
+
+ .. rst-class:: ansible-option-title
+
+ **root_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: rootUrl`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Root URL appended to relative URLs for this client. This is 'rootUrl' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-secret:
+
+ .. rst-class:: ansible-option-title
+
+ **secret**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ When using \ :emphasis:`client\_authenticator\_type`\ \ :literal:`client-secret`\ (the default), you can specify a secret here (otherwise one will be generated if it does not exit). If changing this secret, the module will not register a change currently (but the changed secret will be saved).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-service_accounts_enabled:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-serviceaccountsenabled:
+
+ .. rst-class:: ansible-option-title
+
+ **service_accounts_enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: serviceAccountsEnabled`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Are service accounts enabled for this client or not (OpenID connect). This is 'serviceAccountsEnabled' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-standard_flow_enabled:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-standardflowenabled:
+
+ .. rst-class:: ansible-option-title
+
+ **standard_flow_enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: standardFlowEnabled`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Enable standard flow for this client or not (OpenID connect). This is 'standardFlowEnabled' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the client
+
+ On \ :literal:`present`\ , the client will be created (or updated if it exists already).
+
+ On \ :literal:`absent`\ , the client will be removed if it exists
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-surrogate_auth_required:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-surrogateauthrequired:
+
+ .. rst-class:: ansible-option-title
+
+ **surrogate_auth_required**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: surrogateAuthRequired`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not surrogate auth is required. This is 'surrogateAuthRequired' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-token:
+
+ .. rst-class:: ansible-option-title
+
+ **token**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0`
+
+
+ .. raw:: html
+
+
+
+ Authentication token for Keycloak API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-use_template_config:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-usetemplateconfig:
+
+ .. rst-class:: ansible-option-title
+
+ **use_template_config**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: useTemplateConfig`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to use configuration from the \ :emphasis:`client\_template`\ . This is 'useTemplateConfig' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-use_template_mappers:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-usetemplatemappers:
+
+ .. rst-class:: ansible-option-title
+
+ **use_template_mappers**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: useTemplateMappers`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to use mapper configuration from the \ :emphasis:`client\_template`\ . This is 'useTemplateMappers' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-use_template_scope:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-usetemplatescope:
+
+ .. rst-class:: ansible-option-title
+
+ **use_template_scope**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: useTemplateScope`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to use scope configuration from the \ :emphasis:`client\_template`\ . This is 'useTemplateScope' in the Keycloak REST API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Verify TLS certificates (do not disable this in production).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-web_origins:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__parameter-weborigins:
+
+ .. rst-class:: ansible-option-title
+
+ **web_origins**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: webOrigins`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of allowed CORS origins. This is 'webOrigins' in the Keycloak REST API.
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create or update Keycloak client (minimal example), authentication with credentials
+ middleware_automation.keycloak.keycloak_client:
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ client_id: test
+ state: present
+ delegate_to: localhost
+
+
+ - name: Create or update Keycloak client (minimal example), authentication with token
+ middleware_automation.keycloak.keycloak_client:
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ token: TOKEN
+ client_id: test
+ state: present
+ delegate_to: localhost
+
+
+ - name: Delete a Keycloak client
+ middleware_automation.keycloak.keycloak_client:
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ client_id: test
+ state: absent
+ delegate_to: localhost
+
+
+ - name: Create or update a Keycloak client (with all the bells and whistles)
+ middleware_automation.keycloak.keycloak_client:
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ state: present
+ realm: master
+ client_id: test
+ id: d8b127a3-31f6-44c8-a7e4-4ab9a3e78d95
+ name: this_is_a_test
+ description: Description of this wonderful client
+ root_url: https://www.example.com/
+ admin_url: https://www.example.com/admin_url
+ base_url: basepath
+ enabled: true
+ client_authenticator_type: client-secret
+ secret: REALLYWELLKEPTSECRET
+ redirect_uris:
+ - https://www.example.com/*
+ - http://localhost:8888/
+ web_origins:
+ - https://www.example.com/*
+ not_before: 1507825725
+ bearer_only: false
+ consent_required: false
+ standard_flow_enabled: true
+ implicit_flow_enabled: false
+ direct_access_grants_enabled: false
+ service_accounts_enabled: false
+ authorization_services_enabled: false
+ public_client: false
+ frontchannel_logout: false
+ protocol: openid-connect
+ full_scope_allowed: false
+ node_re_registration_timeout: -1
+ client_template: test
+ use_template_config: false
+ use_template_scope: false
+ use_template_mappers: false
+ always_display_in_console: true
+ registered_nodes:
+ node01.example.com: 1507828202
+ registration_access_token: eyJWT_TOKEN
+ surrogate_auth_required: false
+ default_roles:
+ - test01
+ - test02
+ authentication_flow_binding_overrides:
+ browser: 4c90336b-bf1d-4b87-916d-3677ba4e5fbb
+ protocol_mappers:
+ - config:
+ access.token.claim: true
+ claim.name: "family_name"
+ id.token.claim: true
+ jsonType.label: String
+ user.attribute: lastName
+ userinfo.token.claim: true
+ consentRequired: true
+ consentText: "${familyName}"
+ name: family name
+ protocol: openid-connect
+ protocolMapper: oidc-usermodel-property-mapper
+ - config:
+ attribute.name: Role
+ attribute.nameformat: Basic
+ single: false
+ consentRequired: false
+ name: role list
+ protocol: saml
+ protocolMapper: saml-role-list-mapper
+ attributes:
+ saml.authnstatement: true
+ saml.client.signature: true
+ saml.force.post.binding: true
+ saml.server.signature: true
+ saml.signature.algorithm: RSA_SHA256
+ saml.signing.certificate: CERTIFICATEHERE
+ saml.signing.private.key: PRIVATEKEYHERE
+ saml_force_name_id_format: false
+ saml_name_id_format: username
+ saml_signature_canonicalization_method: "http://www.w3.org/2001/10/xml-exc-c14n#"
+ user.info.response.signature.alg: RS256
+ request.object.signature.alg: RS256
+ use.jwks.url: true
+ jwks.url: JWKS_URL_FOR_CLIENT_AUTH_JWT
+ jwt.credential.certificate: JWT_CREDENTIAL_CERTIFICATE_FOR_CLIENT_AUTH
+ delegate_to: localhost
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__return-end_state:
+
+ .. rst-class:: ansible-option-title
+
+ **end_state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of client after module execution (sample is truncated).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` on success
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"adminUrl": "http://www.example.com/admin\_url", "attributes": {"request.object.signature.alg": "RS256"}}`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__return-existing:
+
+ .. rst-class:: ansible-option-title
+
+ **existing**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of existing client (sample is truncated).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"adminUrl": "http://www.example.com/admin\_url", "attributes": {"request.object.signature.alg": "RS256"}}`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__return-msg:
+
+ .. rst-class:: ansible-option-title
+
+ **msg**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Message as to what action was taken.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Client testclient has been updated"`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_client_module__return-proposed:
+
+ .. rst-class:: ansible-option-title
+
+ **proposed**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of proposed client.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"clientId": "test"}`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Eike Frost (@eikef)
+
+
+
+.. Extra links
+
+
+.. Parsing errors
+
diff --git a/1.2.8/_sources/plugins/keycloak_role.rst.txt b/1.2.8/_sources/plugins/keycloak_role.rst.txt
new file mode 100644
index 0000000..1a664ba
--- /dev/null
+++ b/1.2.8/_sources/plugins/keycloak_role.rst.txt
@@ -0,0 +1,1109 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.middleware_automation.keycloak.keycloak_role_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+keycloak_role -- Allows administration of Keycloak roles via Keycloak API
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `middleware_automation.keycloak collection `_.
+
+ To install it, use: :code:`ansible-galaxy collection install middleware\_automation.keycloak`.
+
+ To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_role`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in middleware\_automation.keycloak 3.4.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows you to add, remove or modify Keycloak roles via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
+- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ https://www.keycloak.org/docs-api/8.0/rest-api/index.html\ .
+- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-attributes:
+
+ .. rst-class:: ansible-option-title
+
+ **attributes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ A dict of key/value pairs to set as custom attributes for the role.
+
+ Values may be single values (e.g. a string) or a list of strings.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-auth_client_id:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_client_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ OpenID Connect \ :emphasis:`client\_id`\ to authenticate to the API with.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin-cli"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-auth_client_secret:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_client_secret**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Client Secret to use in conjunction with \ :emphasis:`auth\_client\_id`\ (if required).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-auth_keycloak_url:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-url:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_keycloak_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: url`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL to the Keycloak instance.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-auth_password:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: password`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password to authenticate for API access with.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-auth_realm:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Keycloak realm name to authenticate to for API access.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-auth_username:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: username`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Username to authenticate for API access with.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-client_id:
+
+ .. rst-class:: ansible-option-title
+
+ **client_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ If the role is a client role, the client id under which it resides.
+
+ If this parameter is absent, the role is considered a realm role.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-connection_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **connection_timeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.5.0`
+
+
+ .. raw:: html
+
+
+
+ Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The role description.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-http_agent:
+
+ .. rst-class:: ansible-option-title
+
+ **http_agent**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 5.4.0`
+
+
+ .. raw:: html
+
+
+
+ Configures the HTTP User-Agent header.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"Ansible"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Name of the role.
+
+ This parameter is required.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-realm:
+
+ .. rst-class:: ansible-option-title
+
+ **realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The Keycloak realm under which this role resides.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"master"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the role.
+
+ On \ :literal:`present`\ , the role will be created if it does not yet exist, or updated with the parameters you provide.
+
+ On \ :literal:`absent`\ , the role will be removed if it exists.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-token:
+
+ .. rst-class:: ansible-option-title
+
+ **token**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0`
+
+
+ .. raw:: html
+
+
+
+ Authentication token for Keycloak API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Verify TLS certificates (do not disable this in production).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create a Keycloak realm role, authentication with credentials
+ middleware_automation.keycloak.keycloak_role:
+ name: my-new-kc-role
+ realm: MyCustomRealm
+ state: present
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ delegate_to: localhost
+
+ - name: Create a Keycloak realm role, authentication with token
+ middleware_automation.keycloak.keycloak_role:
+ name: my-new-kc-role
+ realm: MyCustomRealm
+ state: present
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ token: TOKEN
+ delegate_to: localhost
+
+ - name: Create a Keycloak client role
+ middleware_automation.keycloak.keycloak_role:
+ name: my-new-kc-role
+ realm: MyCustomRealm
+ client_id: MyClient
+ state: present
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ delegate_to: localhost
+
+ - name: Delete a Keycloak role
+ middleware_automation.keycloak.keycloak_role:
+ name: my-role-for-deletion
+ state: absent
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ delegate_to: localhost
+
+ - name: Create a keycloak role with some custom attributes
+ middleware_automation.keycloak.keycloak_role:
+ auth_client_id: admin-cli
+ auth_keycloak_url: https://auth.example.com/auth
+ auth_realm: master
+ auth_username: USERNAME
+ auth_password: PASSWORD
+ name: my-new-role
+ attributes:
+ attrib1: value1
+ attrib2: value2
+ attrib3:
+ - with
+ - numerous
+ - individual
+ - list
+ - items
+ delegate_to: localhost
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__return-end_state:
+
+ .. rst-class:: ansible-option-title
+
+ **end_state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of role after module execution (sample is truncated).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` on success
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My updated client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__return-existing:
+
+ .. rst-class:: ansible-option-title
+
+ **existing**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of existing role.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__return-msg:
+
+ .. rst-class:: ansible-option-title
+
+ **msg**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Message as to what action was taken.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Role myrole has been updated"`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__return-proposed:
+
+ .. rst-class:: ansible-option-title
+
+ **proposed**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of proposed role.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"description": "My updated test description"}`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Laurent Paumier (@laurpaum)
+
+
+
+.. Extra links
+
+
+.. Parsing errors
+
diff --git a/1.2.8/_sources/plugins/keycloak_user_federation.rst.txt b/1.2.8/_sources/plugins/keycloak_user_federation.rst.txt
new file mode 100644
index 0000000..c055e62
--- /dev/null
+++ b/1.2.8/_sources/plugins/keycloak_user_federation.rst.txt
@@ -0,0 +1,3327 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+keycloak_user_federation -- Allows administration of Keycloak user federations via Keycloak API
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `middleware_automation.keycloak collection `_.
+
+ To install it, use: :code:`ansible-galaxy collection install middleware\_automation.keycloak`.
+
+ To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_user_federation`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in middleware\_automation.keycloak 3.7.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows you to add, remove or modify Keycloak user federations via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
+- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html\ .
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-auth_client_id:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_client_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ OpenID Connect \ :emphasis:`client\_id`\ to authenticate to the API with.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin-cli"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-auth_client_secret:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_client_secret**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Client Secret to use in conjunction with \ :emphasis:`auth\_client\_id`\ (if required).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-auth_keycloak_url:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-url:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_keycloak_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: url`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL to the Keycloak instance.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-auth_password:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: password`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password to authenticate for API access with.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-auth_realm:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Keycloak realm name to authenticate to for API access.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-auth_username:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **auth_username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: username`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Username to authenticate for API access with.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config:
+
+ .. rst-class:: ansible-option-title
+
+ **config**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Dict specifying the configuration options for the provider; the contents differ depending on the value of \ :emphasis:`provider\_id`\ . Examples are given below for \ :literal:`ldap`\ , \ :literal:`kerberos`\ and \ :literal:`sssd`\ . It is easiest to obtain valid config values by dumping an already-existing user federation configuration through check-mode in the \ :emphasis:`existing`\ field.
+
+ The value \ :literal:`sssd`\ has been supported since middleware\_automation.keycloak 1.0.0.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/allowkerberosauthentication:
+
+ .. rst-class:: ansible-option-title
+
+ **allowKerberosAuthentication**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data about authenticated users will be provisioned from this LDAP server.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/allowpasswordauthentication:
+
+ .. rst-class:: ansible-option-title
+
+ **allowPasswordAuthentication**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Enable/disable possibility of username/password authentication against Kerberos database.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/authtype:
+
+ .. rst-class:: ansible-option-title
+
+ **authType**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Type of the Authentication method used during LDAP Bind operation. It is used in most of the requests sent to the LDAP server.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"none"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"simple"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/batchsizeforsync:
+
+ .. rst-class:: ansible-option-title
+
+ **batchSizeForSync**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`1000`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/bindcredential:
+
+ .. rst-class:: ansible-option-title
+
+ **bindCredential**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password of LDAP admin.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/binddn:
+
+ .. rst-class:: ansible-option-title
+
+ **bindDn**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ DN of LDAP user which will be used by Keycloak to access LDAP server.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/cachepolicy:
+
+ .. rst-class:: ansible-option-title
+
+ **cachePolicy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Cache Policy for this storage provider.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"DEFAULT"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"EVICT\_DAILY"`
+ - :ansible-option-choices-entry:`"EVICT\_WEEKLY"`
+ - :ansible-option-choices-entry:`"MAX\_LIFESPAN"`
+ - :ansible-option-choices-entry:`"NO\_CACHE"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/changedsyncperiod:
+
+ .. rst-class:: ansible-option-title
+
+ **changedSyncPeriod**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Period for synchronization of changed or newly created LDAP users in seconds.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`-1`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpooling:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPooling**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Determines if Keycloak should use connection pooling for accessing LDAP server.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolingauthentication:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingAuthentication**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ A list of space-separated authentication types of connections that may be pooled.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"none"`
+ - :ansible-option-choices-entry:`"simple"`
+ - :ansible-option-choices-entry:`"DIGEST-MD5"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolingdebug:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingDebug**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ A string that indicates the level of debug output to produce. Example valid values are \ :literal:`fine`\ (trace connection creation and removal) and \ :literal:`all`\ (all debugging information).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolinginitsize:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingInitSize**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ The number of connections per connection identity to create when initially creating a connection for the identity.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolingmaxsize:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingMaxSize**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ The maximum number of connections per connection identity that can be maintained concurrently.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolingprefsize:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingPrefSize**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ The preferred number of connections per connection identity that should be maintained concurrently.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolingprotocol:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingProtocol**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ A list of space-separated protocol types of connections that may be pooled. Valid types are \ :literal:`plain`\ and \ :literal:`ssl`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionpoolingtimeout:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionPoolingTimeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ The number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectiontimeout:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionTimeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ LDAP Connection Timeout in milliseconds.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/connectionurl:
+
+ .. rst-class:: ansible-option-title
+
+ **connectionUrl**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Connection URL to your LDAP server.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/customusersearchfilter:
+
+ .. rst-class:: ansible-option-title
+
+ **customUserSearchFilter**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Additional LDAP Filter for filtering searched users. Leave this empty if you don't need additional filter.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/debug:
+
+ .. rst-class:: ansible-option-title
+
+ **debug**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Enable/disable debug logging to standard output for Krb5LoginModule.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/editmode:
+
+ .. rst-class:: ansible-option-title
+
+ **editMode**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ \ :literal:`READ\_ONLY`\ is a read-only LDAP store. \ :literal:`WRITABLE`\ means data will be synced back to LDAP on demand. \ :literal:`UNSYNCED`\ means user data will be imported, but not synced back to LDAP.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"READ\_ONLY"`
+ - :ansible-option-choices-entry:`"WRITABLE"`
+ - :ansible-option-choices-entry:`"UNSYNCED"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/enabled:
+
+ .. rst-class:: ansible-option-title
+
+ **enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Enable/disable this user federation.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/evictionday:
+
+ .. rst-class:: ansible-option-title
+
+ **evictionDay**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Day of the week the entry will become invalid on.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/evictionhour:
+
+ .. rst-class:: ansible-option-title
+
+ **evictionHour**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Hour of day the entry will become invalid on.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/evictionminute:
+
+ .. rst-class:: ansible-option-title
+
+ **evictionMinute**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Minute of day the entry will become invalid on.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/fullsyncperiod:
+
+ .. rst-class:: ansible-option-title
+
+ **fullSyncPeriod**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Period for full synchronization in seconds.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`-1`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/importenabled:
+
+ .. rst-class:: ansible-option-title
+
+ **importEnabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ If \ :literal:`true`\ , LDAP users will be imported into Keycloak DB and synced by the configured sync policies.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/kerberosrealm:
+
+ .. rst-class:: ansible-option-title
+
+ **kerberosRealm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of kerberos realm.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/keytab:
+
+ .. rst-class:: ansible-option-title
+
+ **keyTab**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Location of Kerberos KeyTab file containing the credentials of server principal. For example \ :literal:`/etc/krb5.keytab`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/maxlifespan:
+
+ .. rst-class:: ansible-option-title
+
+ **maxLifespan**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Max lifespan of cache entry in milliseconds.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/pagination:
+
+ .. rst-class:: ansible-option-title
+
+ **pagination**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Does the LDAP server support pagination.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/priority:
+
+ .. rst-class:: ansible-option-title
+
+ **priority**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ Priority of provider when doing a user lookup. Lowest first.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/rdnldapattribute:
+
+ .. rst-class:: ansible-option-title
+
+ **rdnLDAPAttribute**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of LDAP attribute, which is used as RDN (top attribute) of typical user DN. Usually it's the same as Username LDAP attribute, however it is not required. For example for Active directory, it is common to use \ :literal:`cn`\ as RDN attribute when username attribute might be \ :literal:`sAMAccountName`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/readtimeout:
+
+ .. rst-class:: ansible-option-title
+
+ **readTimeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ LDAP Read Timeout in milliseconds. This timeout applies for LDAP read operations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/searchscope:
+
+ .. rst-class:: ansible-option-title
+
+ **searchScope**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ For one level, the search applies only for users in the DNs specified by User DNs. For subtree, the search applies to the whole subtree. See LDAP documentation for more details.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"1"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"2"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/serverprincipal:
+
+ .. rst-class:: ansible-option-title
+
+ **serverPrincipal**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Full name of server principal for HTTP service including server and domain name. For example \ :literal:`HTTP/host.foo.org@FOO.ORG`\ . Use \ :literal:`\*`\ to accept any service principal in the KeyTab file.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/starttls:
+
+ .. rst-class:: ansible-option-title
+
+ **startTls**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Encrypts the connection to LDAP using STARTTLS, which will disable connection pooling.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/syncregistrations:
+
+ .. rst-class:: ansible-option-title
+
+ **syncRegistrations**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Should newly created users be created within LDAP store? Priority effects which provider is chosen to sync the new user.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/trustemail:
+
+ .. rst-class:: ansible-option-title
+
+ **trustEmail**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ If enabled, email provided by this provider is not verified even if verification is enabled for the realm.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/updateprofilefirstlogin:
+
+ .. rst-class:: ansible-option-title
+
+ **updateProfileFirstLogin**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Update profile on first login.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/usekerberosforpasswordauthentication:
+
+ .. rst-class:: ansible-option-title
+
+ **useKerberosForPasswordAuthentication**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Use Kerberos login module for authenticate username/password against Kerberos server instead of authenticating against LDAP server with Directory Service API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/usepasswordmodifyextendedop:
+
+ .. rst-class:: ansible-option-title
+
+ **usePasswordModifyExtendedOp**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify extended operation usually requires that LDAP user already has password in the LDAP server. So when this is used with 'Sync Registrations', it can be good to add also 'Hardcoded LDAP attribute mapper' with randomly generated initial password.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/usernameldapattribute:
+
+ .. rst-class:: ansible-option-title
+
+ **usernameLDAPAttribute**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of LDAP attribute, which is mapped as Keycloak username. For many LDAP server vendors it can be \ :literal:`uid`\ . For Active directory it can be \ :literal:`sAMAccountName`\ or \ :literal:`cn`\ . The attribute should be filled for all LDAP user records you want to import from LDAP to Keycloak.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/userobjectclasses:
+
+ .. rst-class:: ansible-option-title
+
+ **userObjectClasses**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ All values of LDAP objectClass attribute for users in LDAP divided by comma. For example \ :literal:`inetOrgPerson, organizationalPerson`\ . Newly created Keycloak users will be written to LDAP with all those object classes and existing LDAP user records are found just if they contain all those object classes.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/usersdn:
+
+ .. rst-class:: ansible-option-title
+
+ **usersDn**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Full DN of LDAP tree where your users are. This DN is the parent of LDAP users.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/usetruststorespi:
+
+ .. rst-class:: ansible-option-title
+
+ **useTruststoreSpi**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Specifies whether LDAP connection will use the truststore SPI with the truststore configured in standalone.xml/domain.xml. \ :literal:`Always`\ means that it will always use it. \ :literal:`Never`\ means that it will not use it. \ :literal:`Only for ldaps`\ means that it will use if your connection URL use ldaps. Note even if standalone.xml/domain.xml is not configured, the default Java cacerts or certificate specified by \ :literal:`javax.net.ssl.trustStore`\ property will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"always"`
+ - :ansible-option-choices-entry-default:`"ldapsOnly"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"never"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/uuidldapattribute:
+
+ .. rst-class:: ansible-option-title
+
+ **uuidLDAPAttribute**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of LDAP attribute, which is used as unique object identifier (UUID) for objects in LDAP. For many LDAP server vendors, it is \ :literal:`entryUUID`\ ; however some are different. For example for Active directory it should be \ :literal:`objectGUID`\ . If your LDAP server does not support the notion of UUID, you can use any other attribute that is supposed to be unique among LDAP users in tree.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/validatepasswordpolicy:
+
+ .. rst-class:: ansible-option-title
+
+ **validatePasswordPolicy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Determines if Keycloak should validate the password with the realm password policy before updating it.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-config/vendor:
+
+ .. rst-class:: ansible-option-title
+
+ **vendor**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ LDAP vendor (provider).
+
+ Use short name. For instance, write \ :literal:`rhds`\ for "Red Hat Directory Server".
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-connection_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **connection_timeout**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 4.5.0`
+
+
+ .. raw:: html
+
+
+
+ Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-http_agent:
+
+ .. rst-class:: ansible-option-title
+
+ **http_agent**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 5.4.0`
+
+
+ .. raw:: html
+
+
+
+ Configures the HTTP User-Agent header.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"Ansible"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The unique ID for this user federation. If left empty, the user federation will be searched by its \ :emphasis:`name`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers:
+
+ .. rst-class:: ansible-option-title
+
+ **mappers**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ A list of dicts defining mappers associated with this Identity Provider.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers/config:
+
+ .. rst-class:: ansible-option-title
+
+ **config**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Dict specifying the configuration options for the mapper; the contents differ depending on the value of \ :emphasis:`identityProviderMapper`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers/id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Unique ID of this mapper.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers/name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of the mapper. If no ID is given, the mapper will be searched by name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers/parentid:
+
+ .. rst-class:: ansible-option-title
+
+ **parentId**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Unique ID for the parent of this mapper. ID of the user federation will automatically be used if left blank.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers/providerid:
+
+ .. rst-class:: ansible-option-title
+
+ **providerId**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The mapper type for this mapper (for instance \ :literal:`user-attribute-ldap-mapper`\ ).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-mappers/providertype:
+
+ .. rst-class:: ansible-option-title
+
+ **providerType**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Component type for this mapper.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"org.keycloak.storage.ldap.mappers.LDAPStorageMapper"`
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Display name of provider when linked in admin console.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-parent_id:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-parentid:
+
+ .. rst-class:: ansible-option-title
+
+ **parent_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: parentId`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Unique ID for the parent of this user federation. Realm ID will be automatically used if left blank.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-provider_id:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-providerid:
+
+ .. rst-class:: ansible-option-title
+
+ **provider_id**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: providerId`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Provider for this user federation.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"ldap"`
+ - :ansible-option-choices-entry:`"kerberos"`
+ - :ansible-option-choices-entry:`"sssd"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-provider_type:
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-providertype:
+
+ .. rst-class:: ansible-option-title
+
+ **provider_type**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: providerType`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Component type for user federation (only supported value is \ :literal:`org.keycloak.storage.UserStorageProvider`\ ).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"org.keycloak.storage.UserStorageProvider"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-realm:
+
+ .. rst-class:: ansible-option-title
+
+ **realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The Keycloak realm under which this user federation resides.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`"master"`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the user federation.
+
+ On \ :literal:`present`\ , the user federation will be created if it does not yet exist, or updated with the parameters you provide.
+
+ On \ :literal:`absent`\ , the user federation will be removed if it exists.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-token:
+
+ .. rst-class:: ansible-option-title
+
+ **token**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0`
+
+
+ .. raw:: html
+
+
+
+ Authentication token for Keycloak API.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Verify TLS certificates (do not disable this in production).
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create LDAP user federation
+ middleware_automation.keycloak.keycloak_user_federation:
+ auth_keycloak_url: https://keycloak.example.com/auth
+ auth_realm: master
+ auth_username: admin
+ auth_password: password
+ realm: my-realm
+ name: my-ldap
+ state: present
+ provider_id: ldap
+ provider_type: org.keycloak.storage.UserStorageProvider
+ config:
+ priority: 0
+ enabled: true
+ cachePolicy: DEFAULT
+ batchSizeForSync: 1000
+ editMode: READ_ONLY
+ importEnabled: true
+ syncRegistrations: false
+ vendor: other
+ usernameLDAPAttribute: uid
+ rdnLDAPAttribute: uid
+ uuidLDAPAttribute: entryUUID
+ userObjectClasses: inetOrgPerson, organizationalPerson
+ connectionUrl: ldaps://ldap.example.com:636
+ usersDn: ou=Users,dc=example,dc=com
+ authType: simple
+ bindDn: cn=directory reader
+ bindCredential: password
+ searchScope: 1
+ validatePasswordPolicy: false
+ trustEmail: false
+ useTruststoreSpi: ldapsOnly
+ connectionPooling: true
+ pagination: true
+ allowKerberosAuthentication: false
+ debug: false
+ useKerberosForPasswordAuthentication: false
+ mappers:
+ - name: "full name"
+ providerId: "full-name-ldap-mapper"
+ providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+ config:
+ ldap.full.name.attribute: cn
+ read.only: true
+ write.only: false
+
+ - name: Create Kerberos user federation
+ middleware_automation.keycloak.keycloak_user_federation:
+ auth_keycloak_url: https://keycloak.example.com/auth
+ auth_realm: master
+ auth_username: admin
+ auth_password: password
+ realm: my-realm
+ name: my-kerberos
+ state: present
+ provider_id: kerberos
+ provider_type: org.keycloak.storage.UserStorageProvider
+ config:
+ priority: 0
+ enabled: true
+ cachePolicy: DEFAULT
+ kerberosRealm: EXAMPLE.COM
+ serverPrincipal: HTTP/host.example.com@EXAMPLE.COM
+ keyTab: keytab
+ allowPasswordAuthentication: false
+ updateProfileFirstLogin: false
+
+ - name: Create sssd user federation
+ middleware_automation.keycloak.keycloak_user_federation:
+ auth_keycloak_url: https://keycloak.example.com/auth
+ auth_realm: master
+ auth_username: admin
+ auth_password: password
+ realm: my-realm
+ name: my-sssd
+ state: present
+ provider_id: sssd
+ provider_type: org.keycloak.storage.UserStorageProvider
+ config:
+ priority: 0
+ enabled: true
+ cachePolicy: DEFAULT
+
+ - name: Delete user federation
+ middleware_automation.keycloak.keycloak_user_federation:
+ auth_keycloak_url: https://keycloak.example.com/auth
+ auth_realm: master
+ auth_username: admin
+ auth_password: password
+ realm: my-realm
+ name: my-federation
+ state: absent
+
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__return-end_state:
+
+ .. rst-class:: ansible-option-title
+
+ **end_state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of user federation after module execution.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` on success
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"config": {"allowPasswordAuthentication": "false", "cachePolicy": "DEFAULT", "enabled": "true", "kerberosRealm": "EXAMPLE.COM", "keyTab": "/etc/krb5.keytab", "priority": "0", "serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM", "updateProfileFirstLogin": "false"}, "id": "cf52ae4f-4471-4435-a0cf-bb620cadc122", "mappers": [], "name": "kerberos", "parentId": "myrealm", "providerId": "kerberos", "providerType": "org.keycloak.storage.UserStorageProvider"}`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__return-existing:
+
+ .. rst-class:: ansible-option-title
+
+ **existing**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of existing user federation.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "\*\*\*\*\*\*\*\*\*\*", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "changedSyncPeriod": "-1", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ\_ONLY", "enabled": "true", "fullSyncPeriod": "-1", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "id": "01122837-9047-4ae4-8ca0-6e2e891a765f", "mappers": [{"config": {"always.read.value.from.ldap": "false", "is.mandatory.in.ldap": "false", "ldap.attribute": "mail", "read.only": "true", "user.model.attribute": "email"}, "id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f", "name": "email", "parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f", "providerId": "user-attribute-ldap-mapper", "providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"}], "name": "myfed", "parentId": "myrealm", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__return-msg:
+
+ .. rst-class:: ansible-option-title
+
+ **msg**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Message as to what action was taken.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.middleware_automation.keycloak.keycloak_user_federation_module__return-proposed:
+
+ .. rst-class:: ansible-option-title
+
+ **proposed**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Representation of proposed user federation.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "\*\*\*\*\*\*\*\*\*\*", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ\_ONLY", "enabled": "true", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "name": "ldap", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Laurent Paumier (@laurpaum)
+
+
+
+.. Extra links
+
+
+.. Parsing errors
+
diff --git a/1.2.8/_sources/releasing.md.txt b/1.2.8/_sources/releasing.md.txt
new file mode 100644
index 0000000..537ba1e
--- /dev/null
+++ b/1.2.8/_sources/releasing.md.txt
@@ -0,0 +1,61 @@
+# Collection Versioning Strategy
+
+Each supported collection maintained by Ansible follows Semantic Versioning 2.0.0 (https://semver.org/), for example:
+Given a version number MAJOR.MINOR.PATCH, the following is incremented:
+
+MAJOR version: when making incompatible API changes (see Feature Release scenarios below for examples)
+
+MINOR version: when adding features or functionality in a backwards compatible manner, or updating testing matrix and/or metadata (deprecation)
+
+PATCH version: when adding backwards compatible bug fixes or security fixes (strict).
+
+Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
+
+The first version of a generally available supported collection on Ansible Automation Hub shall be version 1.0.0. NOTE: By default, all newly created collections may begin with a smaller default version of 0.1.0, and therefore a version of 1.0.0 should be explicitly stated by the collection maintainer.
+
+## New content is added to an existing collection
+
+Assuming the current release is 1.0.0, and a new module is ready to be added to the collection, the minor version would be incremented to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.
+
+
+## New feature to existing plugin or role within a collection (backwards compatible)
+
+Assuming the current release is 1.0.0, and new features for an existing module are ready for release . We would increment the MINOR version to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.
+
+
+## Bug fix or security fix to existing content within a collection
+
+Assuming the current release is 1.0.0 and a bug is fixed prior to the next minor release, the PATCH version would be incremented to 1.0.1. The patch indicates only a bug was fixed within a current version. The PATCH release does not contain new content, nor was functionality removed. Bug fixes may be included in a MINOR or MAJOR feature release if the timing allows, eliminating the need for a PATCH dedicated to the fix.
+
+
+## Breaking change to any content within a collection
+
+Assuming the current release is 1.0.0, and a breaking change (API or module) is introduced for a user or developer. The MAJOR version would be incremented to 2.0.0.
+
+Examples of breaking changes within a collection may include but are not limited to:
+
+ - Argspec changes for a module that require either inventory structure or playbook changes.
+ - A change in the shape of either the inbound or returned payload of a filter plugin.
+ - Changes to a connection plugin that require additional inventory parameters or ansible.cfg entries.
+ - New functionality added to a module that changes the outcome of that module as released in previous versions.
+ - The removal of plugins from a collection.
+
+
+## Content removed from a collection
+
+Deleting a module or API is a breaking change. Please see the 'Breaking change' section for how to version this.
+
+
+## A typographical error was fixed in the documentation for a collection
+
+A correction to the README would be considered a bug fix and the PATCH incremented. See 'Bug fix' above.
+
+
+## Documentation added/removed/modified within a collection
+
+Only the PATCH version should be increased for a release that contains changes limited to revised documentation.
+
+
+## Release automation
+
+New releases are triggered by annotated git tags named after semantic versioning. The automation publishes the built artifacts to ansible-galaxy and github releases page.
diff --git a/1.2.8/_sources/roles/index.rst.txt b/1.2.8/_sources/roles/index.rst.txt
new file mode 100644
index 0000000..cad570c
--- /dev/null
+++ b/1.2.8/_sources/roles/index.rst.txt
@@ -0,0 +1,7 @@
+Role Index
+==========
+
+.. toctree::
+ keycloak
+ keycloak_quarkus
+ keycloak_realm
diff --git a/1.2.8/_sources/roles/keycloak.md.txt b/1.2.8/_sources/roles/keycloak.md.txt
new file mode 100644
index 0000000..f25420f
--- /dev/null
+++ b/1.2.8/_sources/roles/keycloak.md.txt
@@ -0,0 +1,213 @@
+keycloak
+========
+
+Install [keycloak](https://keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) server configurations.
+
+
+Requirements
+------------
+
+This role requires the `python3-netaddr` library installed on the controller node.
+
+* to install via yum/dnf: `dnf install python3-netaddr`
+* or via pip: `pip install netaddr==0.8.0`
+* or via the collection: `pip install -r requirements.txt`
+
+
+Dependencies
+------------
+
+The roles depends on:
+
+* [middleware_automation.common](https://github.com/ansible-middleware/common)
+* [ansible-posix](https://docs.ansible.com/ansible/latest/collections/ansible/posix/index.html)
+
+To install all the dependencies via galaxy:
+
+ ansible-galaxy collection install -r requirements.yml
+
+
+Versions
+--------
+
+| RH-SSO VERSION | Release Date | Keycloak Version | EAP Version | Notes |
+|:---------------|:------------------|:-----------------|:------------|:----------------|
+|`7.5.0 GA` |September 20, 2021 |`15.0.2` | `7.4.6` |[Release Notes](https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.5/html/release_notes/index)|
+|`7.6.0 GA` |June 30, 2022 |`18.0.3` | `7.4.6` |[Release Notes](https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html-single/release_notes/index)|
+
+
+Patching
+--------
+
+When variable `keycloak_rhsso_apply_patches` is `True` (default: `False`), the role will automatically apply the latest cumulative patch for the selected base version.
+
+| RH-SSO VERSION | Release Date | RH-SSO LATEST CP | Notes |
+|:---------------|:------------------|:-----------------|:----------------|
+|`7.5.0 GA` |January 20, 2022 |`7.5.3 GA` |[Release Notes](https://access.redhat.com/articles/6646321)|
+|`7.6.0 GA` |November 11, 2022 |`7.6.1 GA` |[Release Notes](https://access.redhat.com/articles/6982711)|
+
+
+Role Defaults
+-------------
+
+* Service configuration
+
+| Variable | Description | Default |
+|:---------|:------------|:---------|
+|`keycloak_ha_enabled`| Enable auto configuration for database backend, clustering and remote caches on infinispan | `False` |
+|`keycloak_ha_discovery`| Discovery protocol for HA cluster members | `JDBC_PING` if keycloak_db_enabled else `TCPPING` |
+|`keycloak_db_enabled`| Enable auto configuration for database backend | `True` if `keycloak_ha_enabled` is True, else `False` |
+|`keycloak_remote_cache_enabled`| Enable remote cache store when in clustered ha configurations | `True` if `keycloak_ha_enabled` else `False` |
+|`keycloak_admin_user`| Administration console user account | `admin` |
+|`keycloak_bind_address`| Address for binding service ports | `0.0.0.0` |
+|`keycloak_management_port_bind_address`| Address for binding management ports | `127.0.0.1` |
+|`keycloak_host`| hostname | `localhost` |
+|`keycloak_http_port`| HTTP port | `8080` |
+|`keycloak_https_port`| TLS HTTP port | `8443` |
+|`keycloak_ajp_port`| AJP port | `8009` |
+|`keycloak_jgroups_port`| jgroups cluster tcp port | `7600` |
+|`keycloak_management_http_port`| Management port | `9990` |
+|`keycloak_management_https_port`| TLS management port | `9993` |
+|`keycloak_prefer_ipv4`| Prefer IPv4 stack and addresses for port binding | `True` |
+|`keycloak_config_standalone_xml`| filename for configuration | `keycloak.xml` |
+|`keycloak_service_user`| posix account username | `keycloak` |
+|`keycloak_service_group`| posix account group | `keycloak` |
+|`keycloak_service_restart_always`| systemd restart always behavior activation | `False`
+|`keycloak_service_restart_on_failure`| systemd restart on-failure behavior activation | `False`
+|`keycloak_service_startlimitintervalsec`| systemd StartLimitIntervalSec | `300` |
+|`keycloak_service_startlimitburst`| systemd StartLimitBurst | `5` |
+|`keycloak_service_restartsec`| systemd RestartSec | `10s` |
+|`keycloak_service_pidfile`| pid file path for service | `/run/keycloak.pid` |
+|`keycloak_features` | List of `name`/`status` pairs of features (also known as profiles on RH-SSO) to `enable` or `disable`, example: `[ { name: 'docker', status: 'enabled' } ]` | `[]`
+|`keycloak_jvm_package`| RHEL java package runtime | `java-1.8.0-openjdk-headless` |
+|`keycloak_java_home`| JAVA_HOME of installed JRE, leave empty for using specified keycloak_jvm_package RPM path | `None` |
+|`keycloak_java_opts`| Additional JVM options | `-Xms1024m -Xmx2048m` |
+
+
+* Install options
+
+| Variable | Description | Default |
+|:---------|:------------|:---------|
+|`keycloak_offline_install` | perform an offline install | `False`|
+|`keycloak_download_url`| Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download//`|
+|`keycloak_version`| keycloak.org package version | `18.0.2` |
+|`keycloak_dest`| Installation root path | `/opt/keycloak` |
+|`keycloak_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_version }}/{{ keycloak_archive }}` |
+|`keycloak_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `False` |
+
+
+* Miscellaneous configuration
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_archive` | keycloak install archive filename | `keycloak-legacy-{{ keycloak_version }}.zip` |
+|`keycloak_download_url_9x` | Download URL for keycloak (deprecated) | `https://downloads.jboss.org/keycloak/{{ keycloak_version }}/{{ keycloak_archive }}` |
+|`keycloak_installdir` | Installation path | `{{ keycloak_dest }}/keycloak-{{ keycloak_version }}` |
+|`keycloak_jboss_home` | Installation work directory | `{{ keycloak_rhsso_installdir }}` |
+|`keycloak_config_dir` | Path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration` |
+|`keycloak_config_path_to_standalone_xml` | Custom path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration/{{ keycloak_config_standalone_xml }}` |
+|`keycloak_config_override_template` | Path to custom template for standalone.xml configuration | `''` |
+|`keycloak_auth_realm` | Name for rest authentication realm | `master` |
+|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` |
+|`keycloak_force_install` | Remove pre-existing versions of service | `False` |
+|`keycloak_url` | URL for configuration rest calls | `http://{{ keycloak_host }}:{{ keycloak_http_port }}` |
+|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port }}` |
+|`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `False` |
+|`keycloak_db_background_validation` | Enable background validation of database connection | `False` |
+|`keycloak_db_background_validation_millis`| How frequenly the connection pool is validated in the background | `10000` if background validation enabled |
+|`keycloak_db_background_validate_on_match` | Enable validate on match for database connections | `False` |
+|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
+
+
+
+Role Variables
+--------------
+
+The following are a set of _required_ variables for the role:
+
+| Variable | Description |
+|:---------|:------------|
+|`keycloak_admin_password`| Password for the administration console user account (minimum 12 characters) |
+|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
+
+
+The following parameters are _required_ only when `keycloak_ha_enabled` is True:
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_modcluster_enabled`| Enable configuration for modcluster subsystem | `True` if `keycloak_ha_enabled` is True, else `False` |
+|`keycloak_modcluster_url` | _deprecated_ Host for the modcluster reverse proxy | `localhost` |
+|`keycloak_modcluster_port` | _deprecated_ Port for the modcluster reverse proxy | `6666` |
+|`keycloak_modcluster_urls` | List of {host,port} dicts for the modcluster reverse proxies | `[ { localhost:6666 } ]` |
+|`keycloak_jdbc_engine` | backend database engine when db is enabled: [ postgres, mariadb, sqlserver ] | `postgres` |
+|`keycloak_infinispan_url` | URL for the infinispan remote-cache server | `localhost:11122` |
+|`keycloak_infinispan_user` | username for connecting to infinispan | `supervisor` |
+|`keycloak_infinispan_pass` | password for connecting to infinispan | `supervisor` |
+|`keycloak_infinispan_sasl_mechanism`| Authentication type | `SCRAM-SHA-512` |
+|`keycloak_infinispan_use_ssl`| Enable hotrod TLS communication | `False` |
+|`keycloak_infinispan_trust_store_path`| Path to truststore with infinispan server certificate | `/etc/pki/java/cacerts` |
+|`keycloak_infinispan_trust_store_password`| Password for opening truststore | `changeit` |
+
+
+The following parameters are _required_ only when `keycloak_db_enabled` is True:
+
+| Variable | Description | Default |
+|:---------|:------------|:---------|
+|`keycloak_jdbc_url` | URL for the postgres backend database | `jdbc:postgresql://localhost:5432/keycloak` |
+|`keycloak_jdbc_driver_version`| Version for the JDBC driver to download | `9.4.1212` |
+|`keycloak_db_user` | username for connecting to postgres | `keycloak-user` |
+|`keycloak_db_pass` | password for connecting to postgres | `keycloak-pass` |
+
+
+The following variables are _optional_:
+
+| Variable | Description |
+|:---------|:------------|
+|`keycloak_db_valid_conn_sql` | Override the default database connection validation query sql |
+|`keycloak_admin_url` | Override the default administration endpoint URL |
+|`keycloak_jgroups_subnet`| Override the subnet match for jgroups cluster formation; if not defined, it will be inferred from local machine route configuration |
+
+Example Playbook
+-----------------
+
+* The following is an example playbook that makes use of the role to install keycloak from remote:
+
+```yaml
+---
+- hosts: ...
+ vars:
+ keycloak_admin_password: "remembertochangeme"
+ roles:
+ - middleware_automation.keycloak.keycloak
+```
+
+
+* The following example playbook makes use of the role to install keycloak from the controller node:
+
+```yaml
+---
+- hosts: ...
+ collections:
+ - middleware_automation.keycloak
+ tasks:
+ - name: Include keycloak role
+ include_role:
+ name: keycloak
+ vars:
+ keycloak_admin_password: "remembertochangeme"
+ keycloak_offline_install: True
+ # This should be the filename of keycloak archive on Ansible node: keycloak-16.1.0.zip
+```
+
+License
+-------
+
+Apache License 2.0
+
+
+Author Information
+------------------
+
+* [Guido Grazioli](https://github.com/guidograzioli)
+* [Romain Pelisse](https://github.com/rpelisse)
+* [Pavan Kumar Motaparthi](https://github.com/motaparthipavankumar)
diff --git a/1.2.8/_sources/roles/keycloak_quarkus.md.txt b/1.2.8/_sources/roles/keycloak_quarkus.md.txt
new file mode 100644
index 0000000..b528944
--- /dev/null
+++ b/1.2.8/_sources/roles/keycloak_quarkus.md.txt
@@ -0,0 +1,121 @@
+keycloak_quarkus
+================
+
+Install [keycloak](https://keycloak.org/) >= 20.0.0 (quarkus) server configurations.
+
+
+Role Defaults
+-------------
+
+* Installation options
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_quarkus_version`| keycloak.org package version | `22.0.1` |
+
+
+* Service configuration
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_quarkus_ha_enabled`| Enable auto configuration for database backend, clustering and remote caches on infinispan | `False` |
+|`keycloak_quarkus_db_enabled`| Enable auto configuration for database backend | `True` if `keycloak_quarkus_ha_enabled` is True, else `False` |
+|`keycloak_quarkus_admin_user`| Administration console user account | `admin` |
+|`keycloak_quarkus_bind_address`| Address for binding service ports | `0.0.0.0` |
+|`keycloak_quarkus_host`| hostname | `localhost` |
+|`keycloak_quarkus_http_port`| HTTP port | `8080` |
+|`keycloak_quarkus_https_port`| TLS HTTP port | `8443` |
+|`keycloak_quarkus_ajp_port`| AJP port | `8009` |
+|`keycloak_quarkus_jgroups_port`| jgroups cluster tcp port | `7600` |
+|`keycloak_quarkus_service_user`| Posix account username | `keycloak` |
+|`keycloak_quarkus_service_group`| Posix account group | `keycloak` |
+|`keycloak_quarkus_service_pidfile`| Pid file path for service | `/run/keycloak.pid` |
+|`keycloak_quarkus_jvm_package`| RHEL java package runtime | `java-17-openjdk-headless` |
+|`keycloak_quarkus_java_home`| JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path | `None` |
+|`keycloak_quarkus_java_opts`| Additional JVM options | `-Xms1024m -Xmx2048m` |
+|`keycloak_quarkus_frontend_url`| Service public URL | `http://localhost:8080/auth` |
+|`keycloak_quarkus_http_relative_path` | Service context path | `auth` |
+|`keycloak_quarkus_http_enabled`| Enable listener on HTTP port | `True` |
+|`keycloak_quarkus_https_enabled`| Enable listener on HTTPS port | `False` |
+|`keycloak_quarkus_key_file`| The file path to a private key in PEM format | `{{ keycloak.home }}/conf/server.key.pem` |
+|`keycloak_quarkus_cert_file`| The file path to a server certificate or certificate chain in PEM format | `{{ keycloak.home }}/conf/server.crt.pem` |
+
+
+* Database configuration
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_quarkus_jdbc_engine` | Database engine [mariadb,postres] | `postgres` |
+|`keycloak_quarkus_db_user` | User for database connection | `keycloak-user` |
+|`keycloak_quarkus_db_pass` | Password for database connection | `keycloak-pass` |
+|`keycloak_quarkus_jdbc_url` | JDBC URL for connecting to database | `jdbc:postgresql://localhost:5432/keycloak` |
+|`keycloak_quarkus_jdbc_driver_version` | Version for JDBC driver | `9.4.1212` |
+
+
+* Remote caches configuration
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_quarkus_ispn_user` | Username for connecting to infinispan | `supervisor` |
+|`keycloak_quarkus_ispn_pass` | Password for connecting to infinispan | `supervisor` |
+|`keycloak_quarkus_ispn_url` | URL for connecting to infinispan | `localhost` |
+|`keycloak_quarkus_ispn_sasl_mechanism` | Infinispan auth mechanism | `SCRAM-SHA-512` |
+|`keycloak_quarkus_ispn_use_ssl` | Whether infinispan uses TLS connection | `false` |
+|`keycloak_quarkus_ispn_trust_store_path` | Path to infinispan server trust certificate | `/etc/pki/java/cacerts` |
+|`keycloak_quarkus_ispn_trust_store_password` | Password for infinispan certificate keystore | `changeit` |
+
+
+* Install options
+
+| Variable | Description | Default |
+|:---------|:------------|:---------|
+|`keycloak_quarkus_offline_install` | Perform an offline install | `False`|
+|`keycloak_quarkus_download_url`| Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download//`|
+|`keycloak_quarkus_version`| keycloak.org package version | `22.0.1` |
+|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` |
+|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` |
+|`keycloak_quarkus_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `False` |
+
+
+* Miscellaneous configuration
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_quarkus_metrics_enabled`| Whether to enable metrics | `False` |
+|`keycloak_quarkus_health_enabled`| If the server should expose health check endpoints | `True` |
+|`keycloak_quarkus_archive` | keycloak install archive filename | `keycloak-{{ keycloak_quarkus_version }}.zip` |
+|`keycloak_quarkus_installdir` | Installation path | `{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}` |
+|`keycloak_quarkus_home` | Installation work directory | `{{ keycloak_quarkus_installdir }}` |
+|`keycloak_quarkus_config_dir` | Path for configuration | `{{ keycloak_quarkus_home }}/conf` |
+|`keycloak_quarkus_master_realm` | Name for rest authentication realm | `master` |
+|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` |
+|`keycloak_force_install` | Remove pre-existing versions of service | `False` |
+|`keycloak_url` | URL for configuration rest calls | `http://{{ keycloak_quarkus_host }}:{{ keycloak_http_port }}` |
+|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_quarkus_host }}:{{ keycloak_management_http_port }}` |
+|`keycloak_quarkus_log`| Enable one or more log handlers in a comma-separated list | `file` |
+|`keycloak_quarkus_log_level`| The log level of the root category or a comma-separated list of individual categories and their levels | `info` |
+|`keycloak_quarkus_log_file`| Set the log file path and filename relative to keycloak home | `data/log/keycloak.log` |
+|`keycloak_quarkus_log_format`| Set a format specific to file log entries | `%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n` |
+|`keycloak_quarkus_proxy_mode`| The proxy address forwarding mode if the server is behind a reverse proxy | `edge` |
+|`keycloak_quarkus_start_dev`| Whether to start the service in development mode (start-dev) | `False` |
+|`keycloak_quarkus_transaction_xa_enabled`| Whether to use XA transactions | `True` |
+
+
+Role Variables
+--------------
+
+| Variable | Description | Required |
+|:---------|:------------|----------|
+|`keycloak_quarkus_admin_pass`| Password of console admin account | `yes` |
+
+
+License
+-------
+
+Apache License 2.0
+
+
+Author Information
+------------------
+
+* [Guido Grazioli](https://github.com/guidograzioli)
diff --git a/1.2.8/_sources/roles/keycloak_realm.md.txt b/1.2.8/_sources/roles/keycloak_realm.md.txt
new file mode 100644
index 0000000..73d823f
--- /dev/null
+++ b/1.2.8/_sources/roles/keycloak_realm.md.txt
@@ -0,0 +1,139 @@
+keycloak_realm
+==============
+
+Create realms and clients in [keycloak](https://keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) services.
+
+
+Role Defaults
+-------------
+
+| Variable | Description | Default |
+|:---------|:------------|:--------|
+|`keycloak_admin_user`| Administration console user account | `admin` |
+|`keycloak_host`| hostname | `localhost` |
+|`keycloak_context`| Context path for rest calls | `/auth` |
+|`keycloak_http_port`| HTTP port | `8080` |
+|`keycloak_https_port`| TLS HTTP port | `8443` |
+|`keycloak_auth_realm`| Name of the main authentication realm | `master` |
+|`keycloak_management_http_port`| Management port | `9990` |
+|`keycloak_auth_client`| Authentication client for configuration REST calls | `admin-cli` |
+|`keycloak_client_public`| Configure a public realm client | `True` |
+|`keycloak_client_web_origins`| Web origins for realm client | `+` |
+|`keycloak_url`| URL for configuration rest calls | `http://{{ keycloak_host }}:{{ keycloak_http_port }}` |
+|`keycloak_management_url`| URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port }}` |
+
+
+Role Variables
+--------------
+
+The following are a set of _required_ variables for the role:
+
+| Variable | Description |
+|:---------|:------------|
+|`keycloak_realm` | Name of the realm to be created |
+|`keycloak_admin_password`| Password for the administration console user account |
+
+
+The following variables are available for creating clients:
+
+| Variable | Description | Default |
+|:---------|:------------|:---------|
+|`keycloak_clients` | List of _client_ declarations for the realm | `[]` |
+|`keycloak_client_default_roles` | List of default role name for clients | `[]` |
+|`keycloak_client_users` | List of user/role mappings for a client | `[]` |
+
+
+The following variable are available for creating user federation:
+
+| Variable | Description | Default |
+|:---------|:------------|:---------|
+|`keycloak_user_federation` | List of _keycloak_user_federation_ for the realm | `[]` |
+
+
+Variable formats
+----------------
+
+* `keycloak_user_federation`, a list of:
+
+```yaml
+ - realm:
+ name:
+ provider_id:
+ provider_type:
+ config:
+ mappers:
+```
+
+Refer to [docs](https://docs.ansible.com/ansible/latest/collections/community/general/keycloak_user_federation_module.html) for information on supported variables.
+
+
+* `keycloak_clients`, a list of:
+
+```yaml
+ - name:
+ id:
+ client_id:
+ roles:
+ realm:
+ public_client:
+ web_origins:
+ users:
+```
+
+`name` and either `id` or `client_id` are required.
+
+
+* `keycloak_client_users`, a list of:
+
+```yaml
+ - username:
+ password:
+ firstName:
+ lastName:
+ email:
+ client_roles:
+```
+
+* Client user/role mappings, a list of:
+
+```yaml
+ - client:
+ role:
+ realm:
+```
+
+For a comprehensive example, refer to the [playbook](../../playbooks/keycloak_realm.yml).
+
+
+Example Playbook
+----------------
+
+The following is an example playbook that makes use of the role to create a realm in keycloak.
+
+```yaml
+---
+- hosts: ...
+ collections:
+ - middleware_automation.keycloak
+ tasks:
+ - name: Include keycloak role
+ include_role:
+ name: keycloak_realm
+ vars:
+ keycloak_admin_password: "changeme"
+ keycloak_realm: TestRealm
+ keycloak_clients: [...]
+```
+
+
+License
+-------
+
+Apache License 2.0
+
+
+Author Information
+------------------
+
+* [Guido Grazioli](https://github.com/guidograzioli)
+* [Romain Pelisse](https://github.com/rpelisse)
\ No newline at end of file
diff --git a/1.2.8/_sources/testing.md.txt b/1.2.8/_sources/testing.md.txt
new file mode 100644
index 0000000..1d06d7f
--- /dev/null
+++ b/1.2.8/_sources/testing.md.txt
@@ -0,0 +1,48 @@
+# Testing
+
+## Continuous integration
+
+The collection is tested with a [molecule](https://github.com/ansible-community/molecule) setup covering the included roles and verifying correct installation and idempotency.
+In order to run the molecule tests locally with python 3.9 available, after cloning the repository:
+
+```
+pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous
+molecule test --all
+```
+
+
+## Integration testing
+
+Demo repositories which depend on the collection, and aggregate functionality with other middleware_automation collections, are automatically rebuilt
+at every collection release to ensure non-breaking changes and consistent behaviour.
+
+The repository are:
+
+ - [Flange demo](https://github.com/ansible-middleware/flange-demo)
+ A deployment of Wildfly cluster integrated with keycloak and infinispan.
+ - [CrossDC keycloak demo](https://github.com/ansible-middleware/cross-dc-rhsso-demo)
+ A clustered multi-regional installation of keycloak with infinispan remote caches.
+
+
+## Test playbooks
+
+Sample playbooks are provided in the `playbooks/` directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows:
+
+```
+# setup environment
+pip install ansible-core
+# clone the repository
+git clone https://github.com/ansible-middleware/keycloak
+cd keycloak
+# install collection dependencies
+ansible-galaxy collection install -r requirements.yml
+# install collection python deps
+pip install -r requirements.txt
+# create inventory for localhost
+cat << EOF > inventory
+[keycloak]
+localhost ansible_connection=local
+EOF
+# run the playbook
+ansible-playbook -i inventory playbooks/keycloak.yml
+```
diff --git a/1.2.8/_static/_sphinx_javascript_frameworks_compat.js b/1.2.8/_static/_sphinx_javascript_frameworks_compat.js
new file mode 100644
index 0000000..8141580
--- /dev/null
+++ b/1.2.8/_static/_sphinx_javascript_frameworks_compat.js
@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+ if (!x) {
+ return x
+ }
+ return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+ if (typeof s === 'undefined')
+ s = document.location.search;
+ var parts = s.substr(s.indexOf('?') + 1).split('&');
+ var result = {};
+ for (var i = 0; i < parts.length; i++) {
+ var tmp = parts[i].split('=', 2);
+ var key = jQuery.urldecode(tmp[0]);
+ var value = jQuery.urldecode(tmp[1]);
+ if (key in result)
+ result[key].push(value);
+ else
+ result[key] = [value];
+ }
+ return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+ function highlight(node, addItems) {
+ if (node.nodeType === 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+ if (pos >= 0 &&
+ !jQuery(node.parentNode).hasClass(className) &&
+ !jQuery(node.parentNode).hasClass("nohighlight")) {
+ var span;
+ var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.className = className;
+ }
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling));
+ node.nodeValue = val.substr(0, pos);
+ if (isInSVG) {
+ var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+ var bbox = node.parentElement.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute('class', className);
+ addItems.push({
+ "parent": node.parentNode,
+ "target": rect});
+ }
+ }
+ }
+ else if (!jQuery(node).is("button, select, textarea")) {
+ jQuery.each(node.childNodes, function() {
+ highlight(this, addItems);
+ });
+ }
+ }
+ var addItems = [];
+ var result = this.each(function() {
+ highlight(this, addItems);
+ });
+ for (var i = 0; i < addItems.length; ++i) {
+ jQuery(addItems[i].parent).before(addItems[i].target);
+ }
+ return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+ jQuery.uaMatch = function(ua) {
+ ua = ua.toLowerCase();
+
+ var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+ /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+ /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+ /(msie) ([\w.]+)/.exec(ua) ||
+ ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+ [];
+
+ return {
+ browser: match[ 1 ] || "",
+ version: match[ 2 ] || "0"
+ };
+ };
+ jQuery.browser = {};
+ jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}
diff --git a/1.2.8/_static/ansible-basic-sphinx-ext.css b/1.2.8/_static/ansible-basic-sphinx-ext.css
new file mode 100644
index 0000000..6f28727
--- /dev/null
+++ b/1.2.8/_static/ansible-basic-sphinx-ext.css
@@ -0,0 +1,2 @@
+@charset "UTF-8";
+/* Copyright (c) Ansible and contributors */table.documentation-table{border-bottom:1px solid #000;border-right:1px solid #000}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid #000;border-top:1px solid #000}table.documentation-table td.elbow-placeholder{border-left:1px solid #000;border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}table.documentation-table .value-type{font-size:x-small;color:purple;display:inline}table.documentation-table .value-separator{font-size:x-small;display:inline}table.documentation-table .value-required{font-size:x-small;color:red;display:inline}table.documentation-table tr .ansibleOptionLink{display:inline-block;visibility:hidden}table.documentation-table tr .ansibleOptionLink:after{content:"🔗"}table.documentation-table tr:hover .ansibleOptionLink:after{visibility:visible}
\ No newline at end of file
diff --git a/1.2.8/_static/antsibull-minimal.css b/1.2.8/_static/antsibull-minimal.css
new file mode 100644
index 0000000..ebc82d8
--- /dev/null
+++ b/1.2.8/_static/antsibull-minimal.css
@@ -0,0 +1,3 @@
+@charset "UTF-8";
+/* Copyright (c) Ansible and contributors */
+/* GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) */.ansible-links{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-align:center;-webkit-align-items:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap}.ansible-links>a{padding:4px 12px;margin:2px 4px;cursor:pointer;border-radius:3px;background-color:#5bbdbf;color:#fff}.ansible-links>a:active,.ansible-links>a:focus,.ansible-links>a:hover{background-color:#91d9db}.ansible-links>a:focus{outline:3px solid #204748}table.documentation-table{border-bottom:1px solid #000;border-right:1px solid #000}table.documentation-table th{background-color:#6ab0de}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid #000;border-top:1px solid #000}table.documentation-table td.elbow-placeholder{border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}table.documentation-table tr .ansibleOptionLink{display:inline-block}table.documentation-table tr .ansibleOptionLink:after{content:"🔗";opacity:0}table.documentation-table tr:hover .ansibleOptionLink:after{opacity:1}table.documentation-table tr:nth-child(odd){background-color:#fff}table.documentation-table tr:nth-child(2n){background-color:#e7f2fa}table.ansible-option-table{display:table;border-color:#000!important;height:1px}table.ansible-option-table tr{height:100%}table.ansible-option-table td,table.ansible-option-table th{border-color:#000!important;border-bottom:none!important;vertical-align:top!important}table.ansible-option-table th>p{font-size:medium!important}table.ansible-option-table thead tr{background-color:#6ab0de}table.ansible-option-table tbody .row-odd td{background-color:#fff!important}table.ansible-option-table tbody .row-even td{background-color:#e7f2fa!important}table.ansible-option-table ul>li>p{margin:0!important}table.ansible-option-table ul>li>div[class^=highlight]{margin-bottom:4px!important}table.ansible-option-table p.ansible-option-title{display:inline}table.ansible-option-table .ansible-option-type-line{font-size:small;margin-bottom:0}table.ansible-option-table .ansible-option-elements,table.ansible-option-table .ansible-option-type{color:purple}table.ansible-option-table .ansible-option-required{color:red}table.ansible-option-table .ansible-option-versionadded{font-style:italic;font-size:small;color:#006400}table.ansible-option-table .ansible-option-aliases{color:#006400;white-space:normal}table.ansible-option-table .ansible-option-line{margin-top:8px}table.ansible-option-table .ansible-option-choices{font-weight:700}table.ansible-option-table .ansible-option-choices-default-mark,table.ansible-option-table .ansible-option-default{color:#00f}table.ansible-option-table .ansible-option-default-bold{color:#00f;font-weight:700}table.ansible-option-table .ansible-option-returned-bold{font-weight:700}table.ansible-option-table .ansible-option-sample{color:#00f;word-wrap:break-word;word-break:break-all}table.ansible-option-table .ansible-option-sample-bold{color:#000;font-weight:700}table.ansible-option-table .ansible-option-configuration{font-weight:700}table.ansible-option-table .ansibleOptionLink{display:inline-block}table.ansible-option-table .ansibleOptionLink:after{content:"🔗";opacity:0}table.ansible-option-table p{margin:0 0 8px}table.ansible-option-table tr:hover .ansibleOptionLink:after{opacity:1}table.ansible-option-table td{padding:0!important;white-space:normal}table.ansible-option-table td>div.ansible-option-cell{padding:8px 16px;border-top:1px solid #000}table.ansible-option-table td:first-child{height:inherit;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:first-child>div.ansible-option-cell{height:inherit;-webkit-box-flex:1;-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;white-space:nowrap;max-width:100%}table.ansible-option-table .ansible-option-indent{margin-left:2em;border-right:1px solid #000}table.ansible-option-table .ansible-attribute-support-label{display:none}table.ansible-option-table .ansible-attribute-support-label,table.ansible-option-table .ansible-attribute-support-property{font-weight:700}table.ansible-option-table .ansible-attribute-support-none{font-weight:700;color:red}table.ansible-option-table .ansible-attribute-support-partial{font-weight:700;color:#a5a500}table.ansible-option-table .ansible-attribute-support-full{font-weight:700;color:green}table.ansible-option-table .ansible-attribute-details{font-style:italic}@media (max-width:1200px){table.ansible-option-table{display:block;height:unset;border:none!important}table.ansible-option-table thead{display:none}table.ansible-option-table tbody,table.ansible-option-table td,table.ansible-option-table tr{display:block;border:none!important}table.ansible-option-table tbody .row-even td,table.ansible-option-table tbody .row-odd td{background-color:unset!important}table.ansible-option-table td>div.ansible-option-cell{border-top:none}table.ansible-option-table td:first-child>div.ansible-option-cell{background-color:#e7f2fa!important}table.ansible-option-table td:not(:first-child){display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:not(:first-child)>div.ansible-option-cell{margin-left:1em}table.ansible-option-table .ansible-option-indent,table.ansible-option-table .ansible-option-indent-desc{margin-left:1em;border:none;border-right:3px solid #e7f2fa}table.ansible-option-table .ansible-attribute-support-label{display:unset}}.ansible-version-added{font-style:italic}.ansible-option-value a.reference.external,.ansible-option-value a.reference.external:hover,.ansible-option-value a.reference.internal,.ansible-option-value a.reference.internal:hover,.ansible-option a.reference.external,.ansible-option a.reference.external:hover,.ansible-option a.reference.internal,.ansible-option a.reference.internal:hover,.ansible-return-value a.reference.external,.ansible-return-value a.reference.external:hover,.ansible-return-value a.reference.internal,.ansible-return-value a.reference.internal:hover{color:unset}
\ No newline at end of file
diff --git a/1.2.8/_static/basic.css b/1.2.8/_static/basic.css
new file mode 100644
index 0000000..30fee9d
--- /dev/null
+++ b/1.2.8/_static/basic.css
@@ -0,0 +1,925 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+div.section::after {
+ display: block;
+ content: '';
+ clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li p.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 360px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+a:visited {
+ color: #551A8B;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+ clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+ display: block;
+ content: '';
+ clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+ margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+ margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+ margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+ float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+ padding-right: 0.5em;
+}
+aside.footnote > p {
+ margin-left: 2em;
+}
+div.citation > p {
+ margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+ margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+.sig dd {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+.sig dl {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0 0.5em;
+ content: ":";
+ display: inline-block;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+.translated {
+ background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+ background-color: rgba(255, 207, 207, 0.2)
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+ clear: both;
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+ white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/1.2.8/_static/css/badge_only.css b/1.2.8/_static/css/badge_only.css
new file mode 100644
index 0000000..c718cee
--- /dev/null
+++ b/1.2.8/_static/css/badge_only.css
@@ -0,0 +1 @@
+.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
\ No newline at end of file
diff --git a/1.2.8/_static/css/fonts/Roboto-Slab-Bold.woff b/1.2.8/_static/css/fonts/Roboto-Slab-Bold.woff
new file mode 100644
index 0000000..6cb6000
Binary files /dev/null and b/1.2.8/_static/css/fonts/Roboto-Slab-Bold.woff differ
diff --git a/1.2.8/_static/css/fonts/Roboto-Slab-Bold.woff2 b/1.2.8/_static/css/fonts/Roboto-Slab-Bold.woff2
new file mode 100644
index 0000000..7059e23
Binary files /dev/null and b/1.2.8/_static/css/fonts/Roboto-Slab-Bold.woff2 differ
diff --git a/1.2.8/_static/css/fonts/Roboto-Slab-Regular.woff b/1.2.8/_static/css/fonts/Roboto-Slab-Regular.woff
new file mode 100644
index 0000000..f815f63
Binary files /dev/null and b/1.2.8/_static/css/fonts/Roboto-Slab-Regular.woff differ
diff --git a/1.2.8/_static/css/fonts/Roboto-Slab-Regular.woff2 b/1.2.8/_static/css/fonts/Roboto-Slab-Regular.woff2
new file mode 100644
index 0000000..f2c76e5
Binary files /dev/null and b/1.2.8/_static/css/fonts/Roboto-Slab-Regular.woff2 differ
diff --git a/1.2.8/_static/css/fonts/fontawesome-webfont.eot b/1.2.8/_static/css/fonts/fontawesome-webfont.eot
new file mode 100644
index 0000000..e9f60ca
Binary files /dev/null and b/1.2.8/_static/css/fonts/fontawesome-webfont.eot differ
diff --git a/1.2.8/_static/css/fonts/fontawesome-webfont.svg b/1.2.8/_static/css/fonts/fontawesome-webfont.svg
new file mode 100644
index 0000000..855c845
--- /dev/null
+++ b/1.2.8/_static/css/fonts/fontawesome-webfont.svg
@@ -0,0 +1,2671 @@
+
+
+
+
+Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016
+ By ,,,
+Copyright Dave Gandy 2016. All rights reserved.
+
+
+
+
+
diff --git a/1.2.8/_static/css/fonts/fontawesome-webfont.ttf b/1.2.8/_static/css/fonts/fontawesome-webfont.ttf
new file mode 100644
index 0000000..35acda2
Binary files /dev/null and b/1.2.8/_static/css/fonts/fontawesome-webfont.ttf differ
diff --git a/1.2.8/_static/css/fonts/fontawesome-webfont.woff b/1.2.8/_static/css/fonts/fontawesome-webfont.woff
new file mode 100644
index 0000000..400014a
Binary files /dev/null and b/1.2.8/_static/css/fonts/fontawesome-webfont.woff differ
diff --git a/1.2.8/_static/css/fonts/fontawesome-webfont.woff2 b/1.2.8/_static/css/fonts/fontawesome-webfont.woff2
new file mode 100644
index 0000000..4d13fc6
Binary files /dev/null and b/1.2.8/_static/css/fonts/fontawesome-webfont.woff2 differ
diff --git a/1.2.8/_static/css/fonts/lato-bold-italic.woff b/1.2.8/_static/css/fonts/lato-bold-italic.woff
new file mode 100644
index 0000000..88ad05b
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-bold-italic.woff differ
diff --git a/1.2.8/_static/css/fonts/lato-bold-italic.woff2 b/1.2.8/_static/css/fonts/lato-bold-italic.woff2
new file mode 100644
index 0000000..c4e3d80
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-bold-italic.woff2 differ
diff --git a/1.2.8/_static/css/fonts/lato-bold.woff b/1.2.8/_static/css/fonts/lato-bold.woff
new file mode 100644
index 0000000..c6dff51
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-bold.woff differ
diff --git a/1.2.8/_static/css/fonts/lato-bold.woff2 b/1.2.8/_static/css/fonts/lato-bold.woff2
new file mode 100644
index 0000000..bb19504
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-bold.woff2 differ
diff --git a/1.2.8/_static/css/fonts/lato-normal-italic.woff b/1.2.8/_static/css/fonts/lato-normal-italic.woff
new file mode 100644
index 0000000..76114bc
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-normal-italic.woff differ
diff --git a/1.2.8/_static/css/fonts/lato-normal-italic.woff2 b/1.2.8/_static/css/fonts/lato-normal-italic.woff2
new file mode 100644
index 0000000..3404f37
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-normal-italic.woff2 differ
diff --git a/1.2.8/_static/css/fonts/lato-normal.woff b/1.2.8/_static/css/fonts/lato-normal.woff
new file mode 100644
index 0000000..ae1307f
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-normal.woff differ
diff --git a/1.2.8/_static/css/fonts/lato-normal.woff2 b/1.2.8/_static/css/fonts/lato-normal.woff2
new file mode 100644
index 0000000..3bf9843
Binary files /dev/null and b/1.2.8/_static/css/fonts/lato-normal.woff2 differ
diff --git a/1.2.8/_static/css/theme.css b/1.2.8/_static/css/theme.css
new file mode 100644
index 0000000..19a446a
--- /dev/null
+++ b/1.2.8/_static/css/theme.css
@@ -0,0 +1,4 @@
+html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*!
+ * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
+ * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
+ */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block}
\ No newline at end of file
diff --git a/1.2.8/_static/doctools.js b/1.2.8/_static/doctools.js
new file mode 100644
index 0000000..d06a71d
--- /dev/null
+++ b/1.2.8/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+ "TEXTAREA",
+ "INPUT",
+ "SELECT",
+ "BUTTON",
+]);
+
+const _ready = (callback) => {
+ if (document.readyState !== "loading") {
+ callback();
+ } else {
+ document.addEventListener("DOMContentLoaded", callback);
+ }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+ init: () => {
+ Documentation.initDomainIndexTable();
+ Documentation.initOnKeyListeners();
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS: {},
+ PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+ LOCALE: "unknown",
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext: (string) => {
+ const translated = Documentation.TRANSLATIONS[string];
+ switch (typeof translated) {
+ case "undefined":
+ return string; // no translation
+ case "string":
+ return translated; // translation exists
+ default:
+ return translated[0]; // (singular, plural) translation tuple exists
+ }
+ },
+
+ ngettext: (singular, plural, n) => {
+ const translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated !== "undefined")
+ return translated[Documentation.PLURAL_EXPR(n)];
+ return n === 1 ? singular : plural;
+ },
+
+ addTranslations: (catalog) => {
+ Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+ Documentation.PLURAL_EXPR = new Function(
+ "n",
+ `return (${catalog.plural_expr})`
+ );
+ Documentation.LOCALE = catalog.locale;
+ },
+
+ /**
+ * helper function to focus on search bar
+ */
+ focusSearchBar: () => {
+ document.querySelectorAll("input[name=q]")[0]?.focus();
+ },
+
+ /**
+ * Initialise the domain index toggle buttons
+ */
+ initDomainIndexTable: () => {
+ const toggler = (el) => {
+ const idNumber = el.id.substr(7);
+ const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+ if (el.src.substr(-9) === "minus.png") {
+ el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+ toggledRows.forEach((el) => (el.style.display = "none"));
+ } else {
+ el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+ toggledRows.forEach((el) => (el.style.display = ""));
+ }
+ };
+
+ const togglerElements = document.querySelectorAll("img.toggler");
+ togglerElements.forEach((el) =>
+ el.addEventListener("click", (event) => toggler(event.currentTarget))
+ );
+ togglerElements.forEach((el) => (el.style.display = ""));
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+ },
+
+ initOnKeyListeners: () => {
+ // only install a listener if it is really needed
+ if (
+ !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+ )
+ return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case "ArrowLeft":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const prevLink = document.querySelector('link[rel="prev"]');
+ if (prevLink && prevLink.href) {
+ window.location.href = prevLink.href;
+ event.preventDefault();
+ }
+ break;
+ case "ArrowRight":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const nextLink = document.querySelector('link[rel="next"]');
+ if (nextLink && nextLink.href) {
+ window.location.href = nextLink.href;
+ event.preventDefault();
+ }
+ break;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
+ switch (event.key) {
+ case "/":
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+ Documentation.focusSearchBar();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/1.2.8/_static/documentation_options.js b/1.2.8/_static/documentation_options.js
new file mode 100644
index 0000000..7e4c114
--- /dev/null
+++ b/1.2.8/_static/documentation_options.js
@@ -0,0 +1,13 @@
+const DOCUMENTATION_OPTIONS = {
+ VERSION: '',
+ LANGUAGE: 'en',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false,
+ SHOW_SEARCH_SUMMARY: true,
+ ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/1.2.8/_static/file.png b/1.2.8/_static/file.png
new file mode 100644
index 0000000..a858a41
Binary files /dev/null and b/1.2.8/_static/file.png differ
diff --git a/1.2.8/_static/jquery.js b/1.2.8/_static/jquery.js
new file mode 100644
index 0000000..c4c6022
--- /dev/null
+++ b/1.2.8/_static/jquery.js
@@ -0,0 +1,2 @@
+/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */
+!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="
"),n("table.docutils.footnote").wrap(""),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n('0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/1.2.8/_static/minus.png b/1.2.8/_static/minus.png
new file mode 100644
index 0000000..d96755f
Binary files /dev/null and b/1.2.8/_static/minus.png differ
diff --git a/1.2.8/_static/plus.png b/1.2.8/_static/plus.png
new file mode 100644
index 0000000..7107cec
Binary files /dev/null and b/1.2.8/_static/plus.png differ
diff --git a/1.2.8/_static/pygments.css b/1.2.8/_static/pygments.css
new file mode 100644
index 0000000..fddd181
--- /dev/null
+++ b/1.2.8/_static/pygments.css
@@ -0,0 +1,81 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc; border: 1px solid #edff00; padding-top: 2px; border-radius: 3px; display: block }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #6a737d; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2; border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .l { color: #032f62 } /* Literal */
+.highlight .n { color: #333333 } /* Name */
+.highlight .o { color: #666666; font-weight: bold } /* Operator */
+.highlight .p { font-weight: bold } /* Punctuation */
+.highlight .ch { color: #6a737d; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #6a737d; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #6a737d; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #6a737d; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .go { color: #333333 } /* Generic.Output */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #007020; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #902000; font-weight: bold } /* Keyword.Type */
+.highlight .ld { color: #032f62 } /* Literal.Date */
+.highlight .m { color: #208050 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086b3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #555555; font-weight: bold } /* Name.Namespace */
+.highlight .nx { color: #333333 } /* Name.Other */
+.highlight .py { color: #333333 } /* Name.Property */
+.highlight .nt { color: #22863a; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #9960b5; font-weight: bold } /* Name.Variable */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
+.highlight .pm { font-weight: bold } /* Punctuation.Marker */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #009999 } /* Literal.Number.Bin */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sa { color: #dd1144 } /* Literal.String.Affix */
+.highlight .sb { color: #dd1144 } /* Literal.String.Backtick */
+.highlight .sc { color: #dd1144 } /* Literal.String.Char */
+.highlight .dl { color: #dd1144 } /* Literal.String.Delimiter */
+.highlight .sd { color: #dd1144; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #dd1144 } /* Literal.String.Double */
+.highlight .se { color: #dd1144; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #dd1144 } /* Literal.String.Heredoc */
+.highlight .si { color: #dd1144; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #dd1144 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #dd1144 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e; font-weight: bold } /* Name.Function.Magic */
+.highlight .vc { color: #008080; font-weight: bold } /* Name.Variable.Class */
+.highlight .vg { color: #008080; font-weight: bold } /* Name.Variable.Global */
+.highlight .vi { color: #008080; font-weight: bold } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5; font-weight: bold } /* Name.Variable.Magic */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/1.2.8/_static/searchtools.js b/1.2.8/_static/searchtools.js
new file mode 100644
index 0000000..7918c3f
--- /dev/null
+++ b/1.2.8/_static/searchtools.js
@@ -0,0 +1,574 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+ const contentRoot = document.documentElement.dataset.content_root;
+
+ const [docName, title, anchor, descr, score, _filename] = item;
+
+ let listItem = document.createElement("li");
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = contentRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = contentRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr) {
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ }
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms)
+ );
+ // highlight search terms in the summary
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = _(
+ `Search finished, found ${resultCount} page(s) matching the search query.`
+ );
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms,
+ highlightTerms,
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms, highlightTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent !== undefined) return docContent.textContent;
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ query: (query) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ // array of [docname, title, anchor, descr, score, filename]
+ let results = [];
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ let score = Math.round(100 * queryLower.length / title.length)
+ results.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id] of foundEntries) {
+ let score = Math.round(100 * queryLower.length / entry.length)
+ results.push([
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ results.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
+
+ // now sort the results by score (in opposite order of appearance, since the
+ // display function below uses pop() to retrieve items) and then
+ // alphabetically
+ results.sort((a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+ });
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ results = results.reverse();
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms, highlightTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord) && !terms[word])
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord) && !titleTerms[word])
+ arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
+ });
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, {});
+ scoreMap.get(file)[word] = record.score;
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
+ fileMap.get(file).push(word);
+ else fileMap.set(file, [word]);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords) => {
+ const text = Search.htmlToText(htmlText);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/1.2.8/_static/sphinx_highlight.js b/1.2.8/_static/sphinx_highlight.js
new file mode 100644
index 0000000..8a96c69
--- /dev/null
+++ b/1.2.8/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ const rest = document.createTextNode(val.substr(pos + text.length));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ rest,
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+ /* There may be more occurrences of search term in this node. So call this
+ * function recursively on the remaining fragment.
+ */
+ _highlight(rest, addItems, text, className);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '' +
+ '' +
+ _("Hide Search Matches") +
+ "
"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(() => {
+ /* Do not call highlightSearchWords() when we are on the search page.
+ * It will highlight words from the *previous* search query.
+ */
+ if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+ SphinxHighlight.initEscapeListener();
+});
diff --git a/1.2.8/developing.html b/1.2.8/developing.html
new file mode 100644
index 0000000..2dcb00c
--- /dev/null
+++ b/1.2.8/developing.html
@@ -0,0 +1,147 @@
+
+
+
+ Contributor’s Guidelines — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+Contributor’s Guidelines
+
+All YAML files named with .yml
Use spaces around jinja variables. {{ var }} {{var}}
Variables that are internal to the role should be lowercase and start with the role name
Keep roles self contained - Roles should avoid including tasks from other roles when possible
Plays should do nothing more than include a list of roles, except where pre_tasks post_tasks
Separators - Use valid names, ie. underscores (e.g. my_role my_playbook my-role
Paths - When defining paths, do not include trailing slashes (e.g. my_path: /foo my_path: /foo/ {{ my_path }}/bar {{ my_path }}bar
Indentation - Use 2 spaces for each indent
vars/ defaults/ vars/ defaults/
All role arguments have a specification in meta/argument_specs.yml
All playbooks/roles should be focused on compatibility with Ansible Automation Platform
+
+
+
+
+
+
+
+
+
Index — Keycloak Ansible Collection documentation
+ Welcome to Keycloak Collection documentation — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+Welcome to Keycloak Collection documentation
+
+
+
Developer documentation
+
+
+
Middleware collections
+
+
+
+
+
+
+
+
+
+
Plugin Index — Keycloak Ansible Collection documentation
+ keycloak_client – Allows administration of Keycloak clients via Keycloak API — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+keycloak_client – Allows administration of Keycloak clients via Keycloak API
+
+
Note
+
This module is part of the middleware_automation.keycloak collection .
+
To install it, use: ansible-galaxy collection install middleware_automation.keycloak
+
To use it in a playbook, specify: middleware_automation.keycloak.keycloak_client
+
+
+
+
+
+
+This module allows the administration of Keycloak clients via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/8.0/rest-api/index.html . Aliases are provided so camelCased versions can be used as well.
The Keycloak API does not always sanity check inputs e.g. you can set SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. If you do not specify a setting, usually a sensible default is chosen.
+
+
+
+
+
+Parameter
Comments
+
+
+
+
admin_url
+
aliases: adminUrl
+
string
+
URL to the admin interface of the client. This is ‘adminUrl’ in the Keycloak REST API.
+
+
+
always_display_in_console
+
aliases: alwaysDisplayInConsole
+
boolean
+
added in middleware_automation.keycloak 4.7.0
+
Whether or not to display this client in account console, even if the user does not have an active session.
+
Choices:
+
+
+
attributes
+
dictionary
+
A dict of further attributes for this client. This can contain various configuration settings; an example is given in the examples section. While an exhaustive list of permissible options is not available; possible options as of Keycloak 3.4 are listed below. The Keycloak API does not validate whether a given option is appropriate for the protocol used; if specified anyway, Keycloak will simply not use it.
+
For OpenID-Connect clients, URL where client keys in JWK are stored.
+
+
jwt.credential.certificate
+
string
+
For OpenID-Connect clients, client certificate for validating JWT issued by client and signed by its key, base64-encoded.
+
+
request.object.signature.alg
+
string
+
For OpenID-Connect clients, JWA algorithm which the client needs to use when sending OIDC request object. One of any none RS256
+
+
saml.authnstatement
+
string
+
For SAML clients, boolean specifying whether or not a statement containing method and timestamp should be included in the login response.
+
+
saml.client.signature
+
string
+
For SAML clients, boolean specifying whether a client signature is required and validated.
+
Boolean specifying whether SAML assertions should be encrypted with the client’s public key.
+
+
saml.force.post.binding
+
string
+
For SAML clients, boolean specifying whether always to use POST binding for responses.
+
+
saml.onetimeuse.condition
+
string
+
For SAML clients, boolean specifying whether a OneTimeUse condition should be included in login responses.
+
+
saml.server.signature
+
string
+
Boolean specifying whether SAML documents should be signed by the realm.
+
+
saml.server.signature.keyinfo.ext
+
string
+
For SAML clients, boolean specifying whether REDIRECT signing key lookup should be optimized through inclusion of the signing key id in the SAML Extensions element.
+
+
saml.signature.algorithm
+
string
+
Signature algorithm used to sign SAML documents. One of RSA_SHA256 RSA_SHA1 RSA_SHA512 DSA_SHA1
+
+
saml.signing.certificate
+
string
+
SAML signing key certificate, base64-encoded.
+
+
saml.signing.private.key
+
string
+
SAML signing key private key, base64-encoded.
+
+
saml_assertion_consumer_url_post
+
string
+
SAML POST Binding URL for the client’s assertion consumer service (login responses).
+
+
saml_assertion_consumer_url_redirect
+
string
+
SAML Redirect Binding URL for the client’s assertion consumer service (login responses).
+
+
saml_force_name_id_format
+
string
+
For SAML clients, Boolean specifying whether to ignore requested NameID subject format and using the configured one instead.
+
+
saml_name_id_format
+
string
+
For SAML clients, the NameID format to use (one of username email transient persistent
+
+
saml_signature_canonicalization_method
+
string
+
SAML signature canonicalization method. This is one of four values, namely http://www.w3.org/2001/10/xml-exc-c14n# http://www.w3.org/2001/10/xml-exc-c14n#WithComments http://www.w3.org/TR/2001/REC-xml-c14n-20010315 http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments
+
+
saml_single_logout_service_url_post
+
string
+
SAML POST binding url for the client’s single logout service.
+
+
saml_single_logout_service_url_redirect
+
string
+
SAML redirect binding url for the client’s single logout service.
+
For OpenID-Connect clients, boolean specifying whether to use a JWKS URL to obtain client public keys.
+
+
user.info.response.signature.alg
+
string
+
For OpenID-Connect clients, JWA algorithm for signed UserInfo-endpoint responses. One of RS256 unsigned
+
+
auth_client_id
+
string
+
OpenID Connect client_id to authenticate to the API with.
+
Default: "admin-cli"
+
+
auth_client_secret
+
string
+
Client Secret to use in conjunction with auth_client_id (if required).
+
+
+
auth_keycloak_url
+
aliases: url
+
string / required
+
URL to the Keycloak instance.
+
+
+
auth_password
+
aliases: password
+
string
+
Password to authenticate for API access with.
+
Keycloak realm name to authenticate to for API access.
+
+
+
auth_username
+
aliases: username
+
string
+
Username to authenticate for API access with.
+
+
+
authentication_flow_binding_overrides
+
aliases: authenticationFlowBindingOverrides
+
dictionary
+
added in middleware_automation.keycloak 3.4.0
+
Override realm authentication flow bindings.
+
+
+
authorization_services_enabled
+
aliases: authorizationServicesEnabled
+
boolean
+
Are authorization services enabled for this client or not (OpenID connect). This is ‘authorizationServicesEnabled’ in the Keycloak REST API.
+
Choices:
+
+
+
+
authorization_settings
+
aliases: authorizationSettings
+
dictionary
+
+
+
base_url
+
aliases: baseUrl
+
string
+
Default URL to use when the auth server needs to redirect or link back to the client This is ‘baseUrl’ in the Keycloak REST API.
+
+
+
bearer_only
+
aliases: bearerOnly
+
boolean
+
The access type of this client is bearer-only. This is ‘bearerOnly’ in the Keycloak REST API.
+
Choices:
+
+
+
+
client_authenticator_type
+
aliases: clientAuthenticatorType
+
string
+
How do clients authenticate with the auth server? Either client-secret client-jwt client-secret secret can set it, while for client-jwt use.jwks.url jwks.url jwt.credential.certificate attributes module parameter to configure its behavior. This is ‘clientAuthenticatorType’ in the Keycloak REST API.
+
Choices:
+
+"client-secret"
"client-jwt"
+
+
+
client_id
+
aliases: clientId
+
string
+
Client id of client to be worked on. This is usually an alphanumeric name chosen by you. Either this or id is required. If you specify both, id takes precedence. This is ‘clientId’ in the Keycloak REST API.
+
+
+
client_template
+
aliases: clientTemplate
+
string
+
Client template to use for this client. If it does not exist this field will silently be dropped. This is ‘clientTemplate’ in the Keycloak REST API.
+
+
connection_timeout
+
integer
+
added in middleware_automation.keycloak 4.5.0
+
Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+
Default: 10
+
+
+
consent_required
+
aliases: consentRequired
+
boolean
+
If enabled, users have to consent to client access. This is ‘consentRequired’ in the Keycloak REST API.
+
Choices:
+
+
+
+
default_client_scopes
+
aliases: defaultClientScopes
+
list / elements=string
+
added in middleware_automation.keycloak 4.7.0
+
List of default client scopes.
+
+
+
default_roles
+
aliases: defaultRoles
+
list / elements=string
+
list of default roles for this client. If the client roles referenced do not exist yet, they will be created. This is ‘defaultRoles’ in the Keycloak REST API.
+
Description of the client in Keycloak.
+
+
+
direct_access_grants_enabled
+
aliases: directAccessGrantsEnabled
+
boolean
+
Are direct access grants enabled for this client or not (OpenID connect). This is ‘directAccessGrantsEnabled’ in the Keycloak REST API.
+
Choices:
+
+
Is this client enabled or not?
+
Choices:
+
+
+
+
frontchannel_logout
+
aliases: frontchannelLogout
+
boolean
+
Is frontchannel logout enabled for this client or not. This is ‘frontchannelLogout’ in the Keycloak REST API.
+
Choices:
+
+
+
+
full_scope_allowed
+
aliases: fullScopeAllowed
+
boolean
+
Is the “Full Scope Allowed” feature set for this client or not. This is ‘fullScopeAllowed’ in the Keycloak REST API.
+
Choices:
+
+
+
http_agent
+
string
+
added in middleware_automation.keycloak 5.4.0
+
Configures the HTTP User-Agent header.
+
Default: "Ansible"
+
Id of client to be worked on. This is usually an UUID. Either this or client_id is required. If you specify both, this takes precedence.
+
+
+
implicit_flow_enabled
+
aliases: implicitFlowEnabled
+
boolean
+
Enable implicit flow for this client or not (OpenID connect). This is ‘implicitFlowEnabled’ in the Keycloak REST API.
+
Choices:
+
+
Name of the client (this is not the same as client_id ).
+
+
+
node_re_registration_timeout
+
aliases: nodeReRegistrationTimeout
+
integer
+
Cluster node re-registration timeout for this client. This is ‘nodeReRegistrationTimeout’ in the Keycloak REST API.
+
+
+
not_before
+
aliases: notBefore
+
integer
+
Revoke any tokens issued before this date for this client (this is a UNIX timestamp). This is ‘notBefore’ in the Keycloak REST API.
+
+
+
optional_client_scopes
+
aliases: optionalClientScopes
+
list / elements=string
+
added in middleware_automation.keycloak 4.7.0
+
List of optional client scopes.
+
Type of client (either openid-connect saml
+
Choices:
+
+"openid-connect"
"saml"
+
+
+
protocol_mappers
+
aliases: protocolMappers
+
list / elements=dictionary
+
a list of dicts defining protocol mappers for this client. This is ‘protocolMappers’ in the Keycloak REST API.
+
Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of protocolMapper and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the existing field.
+
+
+
consentRequired
+
boolean
+
Specifies whether a user needs to provide consent to a client for this mapper to be active.
+
Choices:
+
+
The human-readable name of the consent the user is presented to accept.
+
Usually a UUID specifying the internal ID of this protocol mapper instance.
+
The name of this protocol mapper.
+
This is either openid-connect saml
+
Choices:
+
+"openid-connect"
"saml"
+
+
+
protocolMapper
+
string
+
The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least
+
docker-v2-allow-all-mapper
+
oidc-address-mapper
+
oidc-full-name-mapper
+
oidc-group-membership-mapper
+
oidc-hardcoded-claim-mapper
+
oidc-hardcoded-role-mapper
+
oidc-role-name-mapper
+
oidc-script-based-protocol-mapper
+
oidc-sha256-pairwise-sub-mapper
+
oidc-usermodel-attribute-mapper
+
oidc-usermodel-client-role-mapper
+
oidc-usermodel-property-mapper
+
oidc-usermodel-realm-role-mapper
+
oidc-usersessionmodel-note-mapper
+
saml-group-membership-mapper
+
saml-hardcode-attribute-mapper
+
saml-hardcode-role-mapper
+
saml-role-list-mapper
+
saml-role-name-mapper
+
saml-user-attribute-mapper
+
saml-user-property-mapper
+
saml-user-session-note-mapper
+
An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers and looking under ‘protocol-mapper’.
+
+
+
public_client
+
aliases: publicClient
+
boolean
+
Is the access type for this client public or not. This is ‘publicClient’ in the Keycloak REST API.
+
Choices:
+
+
The realm to create the client in.
+
Default: "master"
+
+
+
redirect_uris
+
aliases: redirectUris
+
list / elements=string
+
Acceptable redirect URIs for this client. This is ‘redirectUris’ in the Keycloak REST API.
+
+
+
registered_nodes
+
aliases: registeredNodes
+
dictionary
+
dict of registered cluster nodes (with nodename
+
+
+
registration_access_token
+
aliases: registrationAccessToken
+
string
+
The registration access token provides access for clients to the client registration service. This is ‘registrationAccessToken’ in the Keycloak REST API.
+
+
+
root_url
+
aliases: rootUrl
+
string
+
Root URL appended to relative URLs for this client. This is ‘rootUrl’ in the Keycloak REST API.
+
When using client_authenticator_type client-secret
+
+
+
service_accounts_enabled
+
aliases: serviceAccountsEnabled
+
boolean
+
Are service accounts enabled for this client or not (OpenID connect). This is ‘serviceAccountsEnabled’ in the Keycloak REST API.
+
Choices:
+
+
+
+
standard_flow_enabled
+
aliases: standardFlowEnabled
+
boolean
+
Enable standard flow for this client or not (OpenID connect). This is ‘standardFlowEnabled’ in the Keycloak REST API.
+
Choices:
+
+
State of the client
+
On present
+
On absent
+
Choices:
+
+"present" ← (default)
"absent"
+
+
+
surrogate_auth_required
+
aliases: surrogateAuthRequired
+
boolean
+
Whether or not surrogate auth is required. This is ‘surrogateAuthRequired’ in the Keycloak REST API.
+
Choices:
+
+
+
token
+
string
+
added in middleware_automation.keycloak 3.0.0
+
Authentication token for Keycloak API.
+
+
+
use_template_config
+
aliases: useTemplateConfig
+
boolean
+
Whether or not to use configuration from the client_template . This is ‘useTemplateConfig’ in the Keycloak REST API.
+
Choices:
+
+
+
+
use_template_mappers
+
aliases: useTemplateMappers
+
boolean
+
Whether or not to use mapper configuration from the client_template . This is ‘useTemplateMappers’ in the Keycloak REST API.
+
Choices:
+
+
+
+
use_template_scope
+
aliases: useTemplateScope
+
boolean
+
Whether or not to use scope configuration from the client_template . This is ‘useTemplateScope’ in the Keycloak REST API.
+
Choices:
+
+
+
validate_certs
+
boolean
+
Verify TLS certificates (do not disable this in production).
+
Choices:
+
+false
true ← (default)
+
+
+
web_origins
+
aliases: webOrigins
+
list / elements=string
+
List of allowed CORS origins. This is ‘webOrigins’ in the Keycloak REST API.
+
+
+
+
+
+
+
+Attribute
Support
Description
+
+Can run in check_mode
+
Will return details on what has changed (or possibly needs changing in check_mode
+
+
+
+
+
+- name : Create or update Keycloak client (minimal example), authentication with credentials
+ middleware_automation.keycloak.keycloak_client :
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ client_id : test
+ state : present
+ delegate_to : localhost
+
+
+- name : Create or update Keycloak client (minimal example), authentication with token
+ middleware_automation.keycloak.keycloak_client :
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ token : TOKEN
+ client_id : test
+ state : present
+ delegate_to : localhost
+
+
+- name : Delete a Keycloak client
+ middleware_automation.keycloak.keycloak_client :
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ client_id : test
+ state : absent
+ delegate_to : localhost
+
+
+- name : Create or update a Keycloak client (with all the bells and whistles)
+ middleware_automation.keycloak.keycloak_client :
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ state : present
+ realm : master
+ client_id : test
+ id : d8b127a3-31f6-44c8-a7e4-4ab9a3e78d95
+ name : this_is_a_test
+ description : Description of this wonderful client
+ root_url : https://www.example.com/
+ admin_url : https://www.example.com/admin_url
+ base_url : basepath
+ enabled : true
+ client_authenticator_type : client-secret
+ secret : REALLYWELLKEPTSECRET
+ redirect_uris :
+ - https://www.example.com/*
+ - http://localhost:8888/
+ web_origins :
+ - https://www.example.com/*
+ not_before : 1507825725
+ bearer_only : false
+ consent_required : false
+ standard_flow_enabled : true
+ implicit_flow_enabled : false
+ direct_access_grants_enabled : false
+ service_accounts_enabled : false
+ authorization_services_enabled : false
+ public_client : false
+ frontchannel_logout : false
+ protocol : openid-connect
+ full_scope_allowed : false
+ node_re_registration_timeout : -1
+ client_template : test
+ use_template_config : false
+ use_template_scope : false
+ use_template_mappers : false
+ always_display_in_console : true
+ registered_nodes :
+ node01.example.com : 1507828202
+ registration_access_token : eyJWT_TOKEN
+ surrogate_auth_required : false
+ default_roles :
+ - test01
+ - test02
+ authentication_flow_binding_overrides :
+ browser : 4c90336b-bf1d-4b87-916d-3677ba4e5fbb
+ protocol_mappers :
+ - config :
+ access.token.claim : true
+ claim.name : "family_name"
+ id.token.claim : true
+ jsonType.label : String
+ user.attribute : lastName
+ userinfo.token.claim : true
+ consentRequired : true
+ consentText : "${familyName}"
+ name : family name
+ protocol : openid-connect
+ protocolMapper : oidc-usermodel-property-mapper
+ - config :
+ attribute.name : Role
+ attribute.nameformat : Basic
+ single : false
+ consentRequired : false
+ name : role list
+ protocol : saml
+ protocolMapper : saml-role-list-mapper
+ attributes :
+ saml.authnstatement : true
+ saml.client.signature : true
+ saml.force.post.binding : true
+ saml.server.signature : true
+ saml.signature.algorithm : RSA_SHA256
+ saml.signing.certificate : CERTIFICATEHERE
+ saml.signing.private.key : PRIVATEKEYHERE
+ saml_force_name_id_format : false
+ saml_name_id_format : username
+ saml_signature_canonicalization_method : "http://www.w3.org/2001/10/xml-exc-c14n#"
+ user.info.response.signature.alg : RS256
+ request.object.signature.alg : RS256
+ use.jwks.url : true
+ jwks.url : JWKS_URL_FOR_CLIENT_AUTH_JWT
+ jwt.credential.certificate : JWT_CREDENTIAL_CERTIFICATE_FOR_CLIENT_AUTH
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+Representation of client after module execution (sample is truncated).
+
Returned: on success
+
Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}
+
Representation of existing client (sample is truncated).
+
Returned: always
+
Sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}
+
Message as to what action was taken.
+
Returned: always
+
Sample: "Client testclient has been updated"
+
Representation of proposed client.
+
Returned: always
+
Sample: {"clientId": "test"}
+
+
+
+
+
+
+
+
+
+
+
+
+
keycloak_role – Allows administration of Keycloak roles via Keycloak API — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+keycloak_role – Allows administration of Keycloak roles via Keycloak API
+
+
Note
+
This module is part of the middleware_automation.keycloak collection .
+
To install it, use: ansible-galaxy collection install middleware_automation.keycloak
+
To use it in a playbook, specify: middleware_automation.keycloak.keycloak_role
+
New in middleware_automation.keycloak 3.4.0
+
+
+
+
+
+
+This module allows you to add, remove or modify Keycloak roles via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/8.0/rest-api/index.html .
Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
+
+
+
+
+
+Parameter
Comments
+
+
+
attributes
+
dictionary
+
A dict of key/value pairs to set as custom attributes for the role.
+
Values may be single values (e.g. a string) or a list of strings.
+
+
auth_client_id
+
string
+
OpenID Connect client_id to authenticate to the API with.
+
Default: "admin-cli"
+
+
auth_client_secret
+
string
+
Client Secret to use in conjunction with auth_client_id (if required).
+
+
+
auth_keycloak_url
+
aliases: url
+
string / required
+
URL to the Keycloak instance.
+
+
+
auth_password
+
aliases: password
+
string
+
Password to authenticate for API access with.
+
Keycloak realm name to authenticate to for API access.
+
+
+
auth_username
+
aliases: username
+
string
+
Username to authenticate for API access with.
+
If the role is a client role, the client id under which it resides.
+
If this parameter is absent, the role is considered a realm role.
+
+
connection_timeout
+
integer
+
added in middleware_automation.keycloak 4.5.0
+
Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+
Default: 10
+
+
http_agent
+
string
+
added in middleware_automation.keycloak 5.4.0
+
Configures the HTTP User-Agent header.
+
Default: "Ansible"
+
+
name
+
string / required
+
Name of the role.
+
This parameter is required.
+
The Keycloak realm under which this role resides.
+
Default: "master"
+
State of the role.
+
On present
+
On absent
+
Choices:
+
+"present" ← (default)
"absent"
+
+
token
+
string
+
added in middleware_automation.keycloak 3.0.0
+
Authentication token for Keycloak API.
+
+
validate_certs
+
boolean
+
Verify TLS certificates (do not disable this in production).
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+
+
+Attribute
Support
Description
+
+Can run in check_mode
+
Will return details on what has changed (or possibly needs changing in check_mode
+
+
+
+
+
+- name : Create a Keycloak realm role, authentication with credentials
+ middleware_automation.keycloak.keycloak_role :
+ name : my-new-kc-role
+ realm : MyCustomRealm
+ state : present
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ delegate_to : localhost
+
+- name : Create a Keycloak realm role, authentication with token
+ middleware_automation.keycloak.keycloak_role :
+ name : my-new-kc-role
+ realm : MyCustomRealm
+ state : present
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ token : TOKEN
+ delegate_to : localhost
+
+- name : Create a Keycloak client role
+ middleware_automation.keycloak.keycloak_role :
+ name : my-new-kc-role
+ realm : MyCustomRealm
+ client_id : MyClient
+ state : present
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ delegate_to : localhost
+
+- name : Delete a Keycloak role
+ middleware_automation.keycloak.keycloak_role :
+ name : my-role-for-deletion
+ state : absent
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ delegate_to : localhost
+
+- name : Create a keycloak role with some custom attributes
+ middleware_automation.keycloak.keycloak_role :
+ auth_client_id : admin-cli
+ auth_keycloak_url : https://auth.example.com/auth
+ auth_realm : master
+ auth_username : USERNAME
+ auth_password : PASSWORD
+ name : my-new-role
+ attributes :
+ attrib1 : value1
+ attrib2 : value2
+ attrib3 :
+ - with
+ - numerous
+ - individual
+ - list
+ - items
+ delegate_to : localhost
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+Representation of role after module execution (sample is truncated).
+
Returned: on success
+
Sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My updated client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}
+
Representation of existing role.
+
Returned: always
+
Sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"}
+
Message as to what action was taken.
+
Returned: always
+
Sample: "Role myrole has been updated"
+
Representation of proposed role.
+
Returned: always
+
Sample: {"description": "My updated test description"}
+
+
+
+
+
+
+
+
+
+
+
+
+
keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API
+
+
Note
+
This module is part of the middleware_automation.keycloak collection .
+
To install it, use: ansible-galaxy collection install middleware_automation.keycloak
+
To use it in a playbook, specify: middleware_automation.keycloak.keycloak_user_federation
+
New in middleware_automation.keycloak 3.7.0
+
+
+
+
+
+
+This module allows you to add, remove or modify Keycloak user federations via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html .
+
+
+
+
+
+Parameter
Comments
+
+
+
auth_client_id
+
string
+
OpenID Connect client_id to authenticate to the API with.
+
Default: "admin-cli"
+
+
auth_client_secret
+
string
+
Client Secret to use in conjunction with auth_client_id (if required).
+
+
+
auth_keycloak_url
+
aliases: url
+
string / required
+
URL to the Keycloak instance.
+
+
+
auth_password
+
aliases: password
+
string
+
Password to authenticate for API access with.
+
Keycloak realm name to authenticate to for API access.
+
+
+
auth_username
+
aliases: username
+
string
+
Username to authenticate for API access with.
+
Dict specifying the configuration options for the provider; the contents differ depending on the value of provider_id . Examples are given below for ldap kerberos sssd existing field.
+
The value sssd
+
+
allowKerberosAuthentication
+
boolean
+
Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data about authenticated users will be provisioned from this LDAP server.
+
Choices:
+
+false ← (default)
true
+
+
allowPasswordAuthentication
+
boolean
+
Enable/disable possibility of username/password authentication against Kerberos database.
+
Choices:
+
+
Type of the Authentication method used during LDAP Bind operation. It is used in most of the requests sent to the LDAP server.
+
Choices:
+
+"none" ← (default)
"simple"
+
+
batchSizeForSync
+
integer
+
Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.
+
Default: 1000
+
+
bindCredential
+
string
+
Password of LDAP admin.
+
DN of LDAP user which will be used by Keycloak to access LDAP server.
+
Cache Policy for this storage provider.
+
Choices:
+
+"DEFAULT" ← (default)
"EVICT_DAILY"
"EVICT_WEEKLY"
"MAX_LIFESPAN"
"NO_CACHE"
+
+
changedSyncPeriod
+
integer
+
Period for synchronization of changed or newly created LDAP users in seconds.
+
Default: -1
+
+
connectionPooling
+
boolean
+
Determines if Keycloak should use connection pooling for accessing LDAP server.
+
Choices:
+
+false
true ← (default)
+
+
connectionPoolingAuthentication
+
string
+
A list of space-separated authentication types of connections that may be pooled.
+
Choices:
+
+"none"
"simple"
"DIGEST-MD5"
+
+
connectionPoolingDebug
+
string
+
A string that indicates the level of debug output to produce. Example valid values are fine all
+
+
connectionPoolingInitSize
+
integer
+
The number of connections per connection identity to create when initially creating a connection for the identity.
+
+
connectionPoolingMaxSize
+
integer
+
The maximum number of connections per connection identity that can be maintained concurrently.
+
+
connectionPoolingPrefSize
+
integer
+
The preferred number of connections per connection identity that should be maintained concurrently.
+
+
connectionPoolingProtocol
+
string
+
A list of space-separated protocol types of connections that may be pooled. Valid types are plain ssl
+
+
connectionPoolingTimeout
+
integer
+
The number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool.
+
+
connectionTimeout
+
integer
+
LDAP Connection Timeout in milliseconds.
+
Connection URL to your LDAP server.
+
+
customUserSearchFilter
+
string
+
Additional LDAP Filter for filtering searched users. Leave this empty if you don’t need additional filter.
+
Enable/disable debug logging to standard output for Krb5LoginModule.
+
Choices:
+
+
READ_ONLY WRITABLE UNSYNCED
+
Choices:
+
+"READ_ONLY"
"WRITABLE"
"UNSYNCED"
+
Enable/disable this user federation.
+
Choices:
+
+false
true ← (default)
+
Day of the week the entry will become invalid on.
+
Hour of day the entry will become invalid on.
+
+
evictionMinute
+
string
+
Minute of day the entry will become invalid on.
+
+
fullSyncPeriod
+
integer
+
Period for full synchronization in seconds.
+
Default: -1
+
+
importEnabled
+
boolean
+
If true
+
Choices:
+
+false
true ← (default)
+
Name of kerberos realm.
+
Location of Kerberos KeyTab file containing the credentials of server principal. For example /etc/krb5.keytab
+
Max lifespan of cache entry in milliseconds.
+
Does the LDAP server support pagination.
+
Choices:
+
+false
true ← (default)
+
Priority of provider when doing a user lookup. Lowest first.
+
Default: 0
+
+
rdnLDAPAttribute
+
string
+
Name of LDAP attribute, which is used as RDN (top attribute) of typical user DN. Usually it’s the same as Username LDAP attribute, however it is not required. For example for Active directory, it is common to use cn sAMAccountName
+
LDAP Read Timeout in milliseconds. This timeout applies for LDAP read operations.
+
For one level, the search applies only for users in the DNs specified by User DNs. For subtree, the search applies to the whole subtree. See LDAP documentation for more details.
+
Choices:
+
+
+
serverPrincipal
+
string
+
Full name of server principal for HTTP service including server and domain name. For example HTTP/host.foo.org@FOO.ORG *
+
Encrypts the connection to LDAP using STARTTLS, which will disable connection pooling.
+
Choices:
+
+false ← (default)
true
+
+
syncRegistrations
+
boolean
+
Should newly created users be created within LDAP store? Priority effects which provider is chosen to sync the new user.
+
Choices:
+
+false ← (default)
true
+
If enabled, email provided by this provider is not verified even if verification is enabled for the realm.
+
Choices:
+
+false ← (default)
true
+
+
updateProfileFirstLogin
+
boolean
+
Update profile on first login.
+
Choices:
+
+
+
useKerberosForPasswordAuthentication
+
boolean
+
Use Kerberos login module for authenticate username/password against Kerberos server instead of authenticating against LDAP server with Directory Service API.
+
Choices:
+
+false ← (default)
true
+
+
usePasswordModifyExtendedOp
+
boolean
+
Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify extended operation usually requires that LDAP user already has password in the LDAP server. So when this is used with ‘Sync Registrations’, it can be good to add also ‘Hardcoded LDAP attribute mapper’ with randomly generated initial password.
+
Choices:
+
+false ← (default)
true
+
+
usernameLDAPAttribute
+
string
+
Name of LDAP attribute, which is mapped as Keycloak username. For many LDAP server vendors it can be uid sAMAccountName cn
+
+
userObjectClasses
+
string
+
All values of LDAP objectClass attribute for users in LDAP divided by comma. For example inetOrgPerson, organizationalPerson
+
Full DN of LDAP tree where your users are. This DN is the parent of LDAP users.
+
+
useTruststoreSpi
+
string
+
Specifies whether LDAP connection will use the truststore SPI with the truststore configured in standalone.xml/domain.xml. Always Never Only for ldaps javax.net.ssl.trustStore
+
Choices:
+
+"always"
"ldapsOnly" ← (default)
"never"
+
+
uuidLDAPAttribute
+
string
+
Name of LDAP attribute, which is used as unique object identifier (UUID) for objects in LDAP. For many LDAP server vendors, it is entryUUID objectGUID
+
+
validatePasswordPolicy
+
boolean
+
Determines if Keycloak should validate the password with the realm password policy before updating it.
+
Choices:
+
+false ← (default)
true
+
LDAP vendor (provider).
+
Use short name. For instance, write rhds
+
+
connection_timeout
+
integer
+
added in middleware_automation.keycloak 4.5.0
+
Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+
Default: 10
+
+
http_agent
+
string
+
added in middleware_automation.keycloak 5.4.0
+
Configures the HTTP User-Agent header.
+
Default: "Ansible"
+
The unique ID for this user federation. If left empty, the user federation will be searched by its name .
+
+
mappers
+
list / elements=dictionary
+
A list of dicts defining mappers associated with this Identity Provider.
+
Dict specifying the configuration options for the mapper; the contents differ depending on the value of identityProviderMapper .
+
Unique ID of this mapper.
+
Name of the mapper. If no ID is given, the mapper will be searched by name.
+
Unique ID for the parent of this mapper. ID of the user federation will automatically be used if left blank.
+
The mapper type for this mapper (for instance user-attribute-ldap-mapper
+
Component type for this mapper.
+
Default: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+
Display name of provider when linked in admin console.
+
+
+
parent_id
+
aliases: parentId
+
string
+
Unique ID for the parent of this user federation. Realm ID will be automatically used if left blank.
+
+
+
provider_id
+
aliases: providerId
+
string
+
Provider for this user federation.
+
Choices:
+
+"ldap"
"kerberos"
"sssd"
+
+
+
provider_type
+
aliases: providerType
+
string
+
Component type for user federation (only supported value is org.keycloak.storage.UserStorageProvider
+
Default: "org.keycloak.storage.UserStorageProvider"
+
The Keycloak realm under which this user federation resides.
+
Default: "master"
+
State of the user federation.
+
On present
+
On absent
+
Choices:
+
+"present" ← (default)
"absent"
+
+
token
+
string
+
added in middleware_automation.keycloak 3.0.0
+
Authentication token for Keycloak API.
+
+
validate_certs
+
boolean
+
Verify TLS certificates (do not disable this in production).
+
Choices:
+
+false
true ← (default)
+
+
+
+
+
+
+
+Attribute
Support
Description
+
+Can run in check_mode
+
Will return details on what has changed (or possibly needs changing in check_mode
+
+
+
+
+
+- name : Create LDAP user federation
+ middleware_automation.keycloak.keycloak_user_federation :
+ auth_keycloak_url : https://keycloak.example.com/auth
+ auth_realm : master
+ auth_username : admin
+ auth_password : password
+ realm : my-realm
+ name : my-ldap
+ state : present
+ provider_id : ldap
+ provider_type : org.keycloak.storage.UserStorageProvider
+ config :
+ priority : 0
+ enabled : true
+ cachePolicy : DEFAULT
+ batchSizeForSync : 1000
+ editMode : READ_ONLY
+ importEnabled : true
+ syncRegistrations : false
+ vendor : other
+ usernameLDAPAttribute : uid
+ rdnLDAPAttribute : uid
+ uuidLDAPAttribute : entryUUID
+ userObjectClasses : inetOrgPerson, organizationalPerson
+ connectionUrl : ldaps://ldap.example.com:636
+ usersDn : ou=Users,dc=example,dc=com
+ authType : simple
+ bindDn : cn=directory reader
+ bindCredential : password
+ searchScope : 1
+ validatePasswordPolicy : false
+ trustEmail : false
+ useTruststoreSpi : ldapsOnly
+ connectionPooling : true
+ pagination : true
+ allowKerberosAuthentication : false
+ debug : false
+ useKerberosForPasswordAuthentication : false
+ mappers :
+ - name : "full name"
+ providerId : "full-name-ldap-mapper"
+ providerType : "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+ config :
+ ldap.full.name.attribute : cn
+ read.only : true
+ write.only : false
+
+- name : Create Kerberos user federation
+ middleware_automation.keycloak.keycloak_user_federation :
+ auth_keycloak_url : https://keycloak.example.com/auth
+ auth_realm : master
+ auth_username : admin
+ auth_password : password
+ realm : my-realm
+ name : my-kerberos
+ state : present
+ provider_id : kerberos
+ provider_type : org.keycloak.storage.UserStorageProvider
+ config :
+ priority : 0
+ enabled : true
+ cachePolicy : DEFAULT
+ kerberosRealm : EXAMPLE.COM
+ serverPrincipal : HTTP/host.example.com@EXAMPLE.COM
+ keyTab : keytab
+ allowPasswordAuthentication : false
+ updateProfileFirstLogin : false
+
+- name : Create sssd user federation
+ middleware_automation.keycloak.keycloak_user_federation :
+ auth_keycloak_url : https://keycloak.example.com/auth
+ auth_realm : master
+ auth_username : admin
+ auth_password : password
+ realm : my-realm
+ name : my-sssd
+ state : present
+ provider_id : sssd
+ provider_type : org.keycloak.storage.UserStorageProvider
+ config :
+ priority : 0
+ enabled : true
+ cachePolicy : DEFAULT
+
+- name : Delete user federation
+ middleware_automation.keycloak.keycloak_user_federation :
+ auth_keycloak_url : https://keycloak.example.com/auth
+ auth_realm : master
+ auth_username : admin
+ auth_password : password
+ realm : my-realm
+ name : my-federation
+ state : absent
+
+
+
+
+Common return values are documented here
+
+
+Key
Description
+
+Representation of user federation after module execution.
+
Returned: on success
+
Sample: {"config": {"allowPasswordAuthentication": "false", "cachePolicy": "DEFAULT", "enabled": "true", "kerberosRealm": "EXAMPLE.COM", "keyTab": "/etc/krb5.keytab", "priority": "0", "serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM", "updateProfileFirstLogin": "false"}, "id": "cf52ae4f-4471-4435-a0cf-bb620cadc122", "mappers": [], "name": "kerberos", "parentId": "myrealm", "providerId": "kerberos", "providerType": "org.keycloak.storage.UserStorageProvider"}
+
Representation of existing user federation.
+
Returned: always
+
Sample: {"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "**********", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "changedSyncPeriod": "-1", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ_ONLY", "enabled": "true", "fullSyncPeriod": "-1", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "id": "01122837-9047-4ae4-8ca0-6e2e891a765f", "mappers": [{"config": {"always.read.value.from.ldap": "false", "is.mandatory.in.ldap": "false", "ldap.attribute": "mail", "read.only": "true", "user.model.attribute": "email"}, "id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f", "name": "email", "parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f", "providerId": "user-attribute-ldap-mapper", "providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"}], "name": "myfed", "parentId": "myrealm", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}
+
Message as to what action was taken.
+
Returned: always
+
Sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."
+
Representation of proposed user federation.
+
Returned: always
+
Sample: {"config": {"allowKerberosAuthentication": "false", "authType": "simple", "batchSizeForSync": "1000", "bindCredential": "**********", "bindDn": "cn=directory reader", "cachePolicy": "DEFAULT", "connectionPooling": "true", "connectionUrl": "ldaps://ldap.example.com:636", "debug": "false", "editMode": "READ_ONLY", "enabled": "true", "importEnabled": "true", "pagination": "true", "priority": "0", "rdnLDAPAttribute": "uid", "searchScope": "1", "syncRegistrations": "false", "trustEmail": "false", "useKerberosForPasswordAuthentication": "false", "useTruststoreSpi": "ldapsOnly", "userObjectClasses": "inetOrgPerson, organizationalPerson", "usernameLDAPAttribute": "uid", "usersDn": "ou=Users,dc=example,dc=com", "uuidLDAPAttribute": "entryUUID", "validatePasswordPolicy": "false", "vendor": "other"}, "name": "ldap", "providerId": "ldap", "providerType": "org.keycloak.storage.UserStorageProvider"}
+
+
+
+
+
+
+
+
+
+
+
+
+
Collection Versioning Strategy — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+Collection Versioning Strategy
+Each supported collection maintained by Ansible follows Semantic Versioning 2.0.0 (https://semver.org/), for example:
+Given a version number MAJOR.MINOR.PATCH, the following is incremented:
+MAJOR version: when making incompatible API changes (see Feature Release scenarios below for examples)
+MINOR version: when adding features or functionality in a backwards compatible manner, or updating testing matrix and/or metadata (deprecation)
+PATCH version: when adding backwards compatible bug fixes or security fixes (strict).
+Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
+The first version of a generally available supported collection on Ansible Automation Hub shall be version 1.0.0. NOTE: By default, all newly created collections may begin with a smaller default version of 0.1.0, and therefore a version of 1.0.0 should be explicitly stated by the collection maintainer.
+
+New content is added to an existing collection
+Assuming the current release is 1.0.0, and a new module is ready to be added to the collection, the minor version would be incremented to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.
+
+
+New feature to existing plugin or role within a collection (backwards compatible)
+Assuming the current release is 1.0.0, and new features for an existing module are ready for release . We would increment the MINOR version to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.
+
+
+Bug fix or security fix to existing content within a collection
+Assuming the current release is 1.0.0 and a bug is fixed prior to the next minor release, the PATCH version would be incremented to 1.0.1. The patch indicates only a bug was fixed within a current version. The PATCH release does not contain new content, nor was functionality removed. Bug fixes may be included in a MINOR or MAJOR feature release if the timing allows, eliminating the need for a PATCH dedicated to the fix.
+
+
+Breaking change to any content within a collection
+Assuming the current release is 1.0.0, and a breaking change (API or module) is introduced for a user or developer. The MAJOR version would be incremented to 2.0.0.
+Examples of breaking changes within a collection may include but are not limited to:
+
+Argspec changes for a module that require either inventory structure or playbook changes.
A change in the shape of either the inbound or returned payload of a filter plugin.
Changes to a connection plugin that require additional inventory parameters or ansible.cfg entries.
New functionality added to a module that changes the outcome of that module as released in previous versions.
The removal of plugins from a collection.
+
+
+Content removed from a collection
+Deleting a module or API is a breaking change. Please see the ‘Breaking change’ section for how to version this.
+
+
+A typographical error was fixed in the documentation for a collection
+A correction to the README would be considered a bug fix and the PATCH incremented. See ‘Bug fix’ above.
+
+
+Documentation added/removed/modified within a collection
+Only the PATCH version should be increased for a release that contains changes limited to revised documentation.
+
+
+Release automation
+New releases are triggered by annotated git tags named after semantic versioning. The automation publishes the built artifacts to ansible-galaxy and github releases page.
+
+
+
+
+
+
+
+
+
+
Role Index — Keycloak Ansible Collection documentation
+ keycloak — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+keycloak
+Install keycloak or Red Hat Single Sign-On server configurations.
+
+Requirements
+This role requires the python3-netaddr
+
+to install via yum/dnf: dnf install python3-netaddr
or via pip: pip install netaddr==0.8.0
or via the collection: pip install -r requirements.txt
+
+
+Dependencies
+The roles depends on:
+
+To install all the dependencies via galaxy:
+
+
+
+Versions
+
+
+RH-SSO VERSION
Release Date
Keycloak Version
EAP Version
Notes
+
+7.5.0 GA
September 20, 2021
15.0.2
7.4.6
Release Notes
7.6.0 GA
June 30, 2022
18.0.3
7.4.6
Release Notes
+
+
+
+Patching
+When variable keycloak_rhsso_apply_patches True False
+
+
+RH-SSO VERSION
Release Date
RH-SSO LATEST CP
Notes
+
+7.5.0 GA
January 20, 2022
7.5.3 GA
Release Notes
7.6.0 GA
November 11, 2022
7.6.1 GA
Release Notes
+
+
+
+Role Defaults
+
+
+
+Variable
Description
Default
+
+keycloak_ha_enabled
Enable auto configuration for database backend, clustering and remote caches on infinispan
False
keycloak_ha_discovery
Discovery protocol for HA cluster members
JDBC_PING TCPPING
keycloak_db_enabled
Enable auto configuration for database backend
True keycloak_ha_enabled False
keycloak_remote_cache_enabled
Enable remote cache store when in clustered ha configurations
True keycloak_ha_enabled False
keycloak_admin_user
Administration console user account
admin
keycloak_bind_address
Address for binding service ports
0.0.0.0
keycloak_management_port_bind_address
Address for binding management ports
127.0.0.1
keycloak_host
hostname
localhost
keycloak_http_port
HTTP port
8080
keycloak_https_port
TLS HTTP port
8443
keycloak_ajp_port
AJP port
8009
keycloak_jgroups_port
jgroups cluster tcp port
7600
keycloak_management_http_port
Management port
9990
keycloak_management_https_port
TLS management port
9993
keycloak_prefer_ipv4
Prefer IPv4 stack and addresses for port binding
True
keycloak_config_standalone_xml
filename for configuration
keycloak.xml
keycloak_service_user
posix account username
keycloak
keycloak_service_group
posix account group
keycloak
keycloak_service_restart_always
systemd restart always behavior activation
False
keycloak_service_restart_on_failure
systemd restart on-failure behavior activation
False
keycloak_service_startlimitintervalsec
systemd StartLimitIntervalSec
300
keycloak_service_startlimitburst
systemd StartLimitBurst
5
keycloak_service_restartsec
systemd RestartSec
10s
keycloak_service_pidfile
pid file path for service
/run/keycloak.pid
keycloak_features
List of name status enable disable [ { name: 'docker', status: 'enabled' } ]
[]
keycloak_jvm_package
RHEL java package runtime
java-1.8.0-openjdk-headless
keycloak_java_home
JAVA_HOME of installed JRE, leave empty for using specified keycloak_jvm_package RPM path
None
keycloak_java_opts
Additional JVM options
-Xms1024m -Xmx2048m
+
+
+
+
+Variable
Description
Default
+
+keycloak_offline_install
perform an offline install
False
keycloak_download_url
Download URL for keycloak
https://github.com/keycloak/keycloak/releases/download/<version>/<archive>
keycloak_version
keycloak.org package version
18.0.2
keycloak_dest
Installation root path
/opt/keycloak
keycloak_download_url
Download URL for keycloak
https://github.com/keycloak/keycloak/releases/download/{{ keycloak_version }}/{{ keycloak_archive }}
keycloak_configure_firewalld
Ensure firewalld is running and configure keycloak ports
False
+
+
+
+
+Variable
Description
Default
+
+keycloak_archive
keycloak install archive filename
keycloak-legacy-{{ keycloak_version }}.zip
keycloak_download_url_9x
Download URL for keycloak (deprecated)
https://downloads.jboss.org/keycloak/{{ keycloak_version }}/{{ keycloak_archive }}
keycloak_installdir
Installation path
{{ keycloak_dest }}/keycloak-{{ keycloak_version }}
keycloak_jboss_home
Installation work directory
{{ keycloak_rhsso_installdir }}
keycloak_config_dir
Path for configuration
{{ keycloak_jboss_home }}/standalone/configuration
keycloak_config_path_to_standalone_xml
Custom path for configuration
{{ keycloak_jboss_home }}/standalone/configuration/{{ keycloak_config_standalone_xml }}
keycloak_config_override_template
Path to custom template for standalone.xml configuration
''
keycloak_auth_realm
Name for rest authentication realm
master
keycloak_auth_client
Authentication client for configuration REST calls
admin-cli
keycloak_force_install
Remove pre-existing versions of service
False
keycloak_url
URL for configuration rest calls
http://{{ keycloak_host }}:{{ keycloak_http_port }}
keycloak_management_url
URL for management console rest calls
http://{{ keycloak_host }}:{{ keycloak_management_http_port }}
keycloak_frontend_url_force
Force backend requests to use the frontend URL
False
keycloak_db_background_validation
Enable background validation of database connection
False
keycloak_db_background_validation_millis
How frequenly the connection pool is validated in the background
10000
keycloak_db_background_validate_on_match
Enable validate on match for database connections
False
keycloak_frontend_url
frontend URL for keycloak endpoint
http://localhost:8080/auth/
+
+
+
+Role Variables
+The following are a set of required variables for the role:
+
+
+Variable
Description
+
+keycloak_admin_password
Password for the administration console user account (minimum 12 characters)
keycloak_frontend_url
frontend URL for keycloak endpoint
+
+The following parameters are required only when keycloak_ha_enabled
+
+
+Variable
Description
Default
+
+keycloak_modcluster_enabled
Enable configuration for modcluster subsystem
True keycloak_ha_enabled False
keycloak_modcluster_url
deprecated Host for the modcluster reverse proxy
localhost
keycloak_modcluster_port
deprecated Port for the modcluster reverse proxy
6666
keycloak_modcluster_urls
List of {host,port} dicts for the modcluster reverse proxies
[ { localhost:6666 } ]
keycloak_jdbc_engine
backend database engine when db is enabled: [ postgres, mariadb, sqlserver ]
postgres
keycloak_infinispan_url
URL for the infinispan remote-cache server
localhost:11122
keycloak_infinispan_user
username for connecting to infinispan
supervisor
keycloak_infinispan_pass
password for connecting to infinispan
supervisor
keycloak_infinispan_sasl_mechanism
Authentication type
SCRAM-SHA-512
keycloak_infinispan_use_ssl
Enable hotrod TLS communication
False
keycloak_infinispan_trust_store_path
Path to truststore with infinispan server certificate
/etc/pki/java/cacerts
keycloak_infinispan_trust_store_password
Password for opening truststore
changeit
+
+The following parameters are required only when keycloak_db_enabled
+
+
+Variable
Description
Default
+
+keycloak_jdbc_url
URL for the postgres backend database
jdbc:postgresql://localhost:5432/keycloak
keycloak_jdbc_driver_version
Version for the JDBC driver to download
9.4.1212
keycloak_db_user
username for connecting to postgres
keycloak-user
keycloak_db_pass
password for connecting to postgres
keycloak-pass
+
+The following variables are optional :
+
+
+Variable
Description
+
+keycloak_db_valid_conn_sql
Override the default database connection validation query sql
keycloak_admin_url
Override the default administration endpoint URL
keycloak_jgroups_subnet
Override the subnet match for jgroups cluster formation; if not defined, it will be inferred from local machine route configuration
+
+
+
+Example Playbook
+
+---
+- hosts : ...
+ vars :
+ keycloak_admin_password : "remembertochangeme"
+ roles :
+ - middleware_automation.keycloak.keycloak
+
+
---
+- hosts : ...
+ collections :
+ - middleware_automation.keycloak
+ tasks :
+ - name : Include keycloak role
+ include_role :
+ name : keycloak
+ vars :
+ keycloak_admin_password : "remembertochangeme"
+ keycloak_offline_install : True
+ # This should be the filename of keycloak archive on Ansible node: keycloak-16.1.0.zip
+
+
+
+License
+Apache License 2.0
+
+
+
+
+
+
+
+
+
+
+
keycloak_quarkus — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+keycloak_quarkus
+Install keycloak >= 20.0.0 (quarkus) server configurations.
+
+Role Defaults
+
+
+
+Variable
Description
Default
+
+keycloak_quarkus_version
keycloak.org package version
22.0.1
+
+
+
+
+Variable
Description
Default
+
+keycloak_quarkus_ha_enabled
Enable auto configuration for database backend, clustering and remote caches on infinispan
False
keycloak_quarkus_db_enabled
Enable auto configuration for database backend
True keycloak_quarkus_ha_enabled False
keycloak_quarkus_admin_user
Administration console user account
admin
keycloak_quarkus_bind_address
Address for binding service ports
0.0.0.0
keycloak_quarkus_host
hostname
localhost
keycloak_quarkus_http_port
HTTP port
8080
keycloak_quarkus_https_port
TLS HTTP port
8443
keycloak_quarkus_ajp_port
AJP port
8009
keycloak_quarkus_jgroups_port
jgroups cluster tcp port
7600
keycloak_quarkus_service_user
Posix account username
keycloak
keycloak_quarkus_service_group
Posix account group
keycloak
keycloak_quarkus_service_pidfile
Pid file path for service
/run/keycloak.pid
keycloak_quarkus_jvm_package
RHEL java package runtime
java-17-openjdk-headless
keycloak_quarkus_java_home
JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path
None
keycloak_quarkus_java_opts
Additional JVM options
-Xms1024m -Xmx2048m
keycloak_quarkus_frontend_url
Service public URL
http://localhost:8080/auth
keycloak_quarkus_http_relative_path
Service context path
auth
keycloak_quarkus_http_enabled
Enable listener on HTTP port
True
keycloak_quarkus_https_enabled
Enable listener on HTTPS port
False
keycloak_quarkus_key_file
The file path to a private key in PEM format
{{ keycloak.home }}/conf/server.key.pem
keycloak_quarkus_cert_file
The file path to a server certificate or certificate chain in PEM format
{{ keycloak.home }}/conf/server.crt.pem
+
+
+Database configuration
+
+
+Variable
Description
Default
+
+keycloak_quarkus_jdbc_engine
Database engine [mariadb,postres]
postgres
keycloak_quarkus_db_user
User for database connection
keycloak-user
keycloak_quarkus_db_pass
Password for database connection
keycloak-pass
keycloak_quarkus_jdbc_url
JDBC URL for connecting to database
jdbc:postgresql://localhost:5432/keycloak
keycloak_quarkus_jdbc_driver_version
Version for JDBC driver
9.4.1212
+
+
+
+
+Variable
Description
Default
+
+keycloak_quarkus_ispn_user
Username for connecting to infinispan
supervisor
keycloak_quarkus_ispn_pass
Password for connecting to infinispan
supervisor
keycloak_quarkus_ispn_url
URL for connecting to infinispan
localhost
keycloak_quarkus_ispn_sasl_mechanism
Infinispan auth mechanism
SCRAM-SHA-512
keycloak_quarkus_ispn_use_ssl
Whether infinispan uses TLS connection
false
keycloak_quarkus_ispn_trust_store_path
Path to infinispan server trust certificate
/etc/pki/java/cacerts
keycloak_quarkus_ispn_trust_store_password
Password for infinispan certificate keystore
changeit
+
+
+
+
+Variable
Description
Default
+
+keycloak_quarkus_offline_install
Perform an offline install
False
keycloak_quarkus_download_url
Download URL for keycloak
https://github.com/keycloak/keycloak/releases/download/<version>/<archive>
keycloak_quarkus_version
keycloak.org package version
22.0.1
keycloak_quarkus_dest
Installation root path
/opt/keycloak
keycloak_quarkus_download_url
Download URL for keycloak
https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}
keycloak_quarkus_configure_firewalld
Ensure firewalld is running and configure keycloak ports
False
+
+
+
+
+Variable
Description
Default
+
+keycloak_quarkus_metrics_enabled
Whether to enable metrics
False
keycloak_quarkus_health_enabled
If the server should expose health check endpoints
True
keycloak_quarkus_archive
keycloak install archive filename
keycloak-{{ keycloak_quarkus_version }}.zip
keycloak_quarkus_installdir
Installation path
{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}
keycloak_quarkus_home
Installation work directory
{{ keycloak_quarkus_installdir }}
keycloak_quarkus_config_dir
Path for configuration
{{ keycloak_quarkus_home }}/conf
keycloak_quarkus_master_realm
Name for rest authentication realm
master
keycloak_auth_client
Authentication client for configuration REST calls
admin-cli
keycloak_force_install
Remove pre-existing versions of service
False
keycloak_url
URL for configuration rest calls
http://{{ keycloak_quarkus_host }}:{{ keycloak_http_port }}
keycloak_management_url
URL for management console rest calls
http://{{ keycloak_quarkus_host }}:{{ keycloak_management_http_port }}
keycloak_quarkus_log
Enable one or more log handlers in a comma-separated list
file
keycloak_quarkus_log_level
The log level of the root category or a comma-separated list of individual categories and their levels
info
keycloak_quarkus_log_file
Set the log file path and filename relative to keycloak home
data/log/keycloak.log
keycloak_quarkus_log_format
Set a format specific to file log entries
%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n
keycloak_quarkus_proxy_mode
The proxy address forwarding mode if the server is behind a reverse proxy
edge
keycloak_quarkus_start_dev
Whether to start the service in development mode (start-dev)
False
keycloak_quarkus_transaction_xa_enabled
Whether to use XA transactions
True
+
+
+
+Role Variables
+
+
+Variable
Description
Required
+
+keycloak_quarkus_admin_pass
Password of console admin account
yes
+
+
+
+License
+Apache License 2.0
+
+
+
+
+
+
+
+
+
+
+
keycloak_realm — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+keycloak_realm
+Create realms and clients in keycloak or Red Hat Single Sign-On services.
+
+Role Defaults
+
+
+Variable
Description
Default
+
+keycloak_admin_user
Administration console user account
admin
keycloak_host
hostname
localhost
keycloak_context
Context path for rest calls
/auth
keycloak_http_port
HTTP port
8080
keycloak_https_port
TLS HTTP port
8443
keycloak_auth_realm
Name of the main authentication realm
master
keycloak_management_http_port
Management port
9990
keycloak_auth_client
Authentication client for configuration REST calls
admin-cli
keycloak_client_public
Configure a public realm client
True
keycloak_client_web_origins
Web origins for realm client
+
keycloak_url
URL for configuration rest calls
http://{{ keycloak_host }}:{{ keycloak_http_port }}
keycloak_management_url
URL for management console rest calls
http://{{ keycloak_host }}:{{ keycloak_management_http_port }}
+
+
+
+Role Variables
+The following are a set of required variables for the role:
+
+
+Variable
Description
+
+keycloak_realm
Name of the realm to be created
keycloak_admin_password
Password for the administration console user account
+
+The following variables are available for creating clients:
+
+
+Variable
Description
Default
+
+keycloak_clients
List of client declarations for the realm
[]
keycloak_client_default_roles
List of default role name for clients
[]
keycloak_client_users
List of user/role mappings for a client
[]
+
+The following variable are available for creating user federation:
+
+
+Variable
Description
Default
+
+keycloak_user_federation
List of keycloak_user_federation for the realm
[]
+
+
+
+
+Example Playbook
+The following is an example playbook that makes use of the role to create a realm in keycloak.
+---
+- hosts : ...
+ collections :
+ - middleware_automation.keycloak
+ tasks :
+ - name : Include keycloak role
+ include_role :
+ name : keycloak_realm
+ vars :
+ keycloak_admin_password : "changeme"
+ keycloak_realm : TestRealm
+ keycloak_clients : [ ... ]
+
+
+
+License
+Apache License 2.0
+
+
+
+
+
+
+
+
+
+
+
Search — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Testing — Keycloak Ansible Collection documentation
+
+
+
+
+
+
+ Keycloak Ansible Collection
+
+
+
+
+
+
+
+
+
+Testing
+
+Continuous integration
+The collection is tested with a molecule setup covering the included roles and verifying correct installation and idempotency.
+In order to run the molecule tests locally with python 3.9 available, after cloning the repository:
+pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous
+molecule test --all
+
+
+
+Integration testing
+Demo repositories which depend on the collection, and aggregate functionality with other middleware_automation collections, are automatically rebuilt
+at every collection release to ensure non-breaking changes and consistent behaviour.
+The repository are:
+
+
+
+Test playbooks
+Sample playbooks are provided in the playbooks/
+# setup environment
+pip install ansible-core
+# clone the repository
+git clone https://github.com/ansible-middleware/keycloak
+cd keycloak
+# install collection dependencies
+ansible-galaxy collection install -r requirements.yml
+# install collection python deps
+pip install -r requirements.txt
+# create inventory for localhost
+cat << EOF > inventory
+[keycloak]
+localhost ansible_connection=local
+EOF
+# run the playbook
+ansible-playbook -i inventory playbooks/keycloak.yml
+
+
+
+
+
+
+
+
+
+
+
