mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-21 14:48:50 +00:00
AMW-622 keycloak collection spelling and grammar checking for PRs
This commit is contained in:
@@ -0,0 +1,88 @@
|
|||||||
|
# Keycloak / Ansible domain-specific words
|
||||||
|
# Only terms NOT covered by built-in dictionaries
|
||||||
|
|
||||||
|
# Product names and projects
|
||||||
|
Infinispan
|
||||||
|
infinispan
|
||||||
|
Wildfly
|
||||||
|
wildfly
|
||||||
|
keycloak
|
||||||
|
|
||||||
|
# Red Hat product names
|
||||||
|
RHBK
|
||||||
|
rhbk
|
||||||
|
rhsso
|
||||||
|
|
||||||
|
# Java / JBoss terms
|
||||||
|
Djboss
|
||||||
|
Djgroups
|
||||||
|
Dsun
|
||||||
|
ispn
|
||||||
|
ISPN
|
||||||
|
jaegertracing
|
||||||
|
jaxrs
|
||||||
|
jberet
|
||||||
|
JDBCPING
|
||||||
|
jgroups
|
||||||
|
JGROUPSPING
|
||||||
|
jndi
|
||||||
|
keytool
|
||||||
|
MPING
|
||||||
|
NAKACK
|
||||||
|
passivation
|
||||||
|
passivating
|
||||||
|
slsb
|
||||||
|
sfsb
|
||||||
|
TCPPING
|
||||||
|
tcpping
|
||||||
|
jdbcx
|
||||||
|
cacerts
|
||||||
|
changeit
|
||||||
|
|
||||||
|
# Systemd directives
|
||||||
|
restartsec
|
||||||
|
runas
|
||||||
|
startlimitburst
|
||||||
|
systemdunit
|
||||||
|
|
||||||
|
# Ansible terms
|
||||||
|
fqcn
|
||||||
|
FQCN
|
||||||
|
|
||||||
|
# WildFly / JBoss terms
|
||||||
|
jbcs
|
||||||
|
modcluster
|
||||||
|
|
||||||
|
# Linux / System terms
|
||||||
|
firewalld
|
||||||
|
cgroupns
|
||||||
|
zgrep
|
||||||
|
|
||||||
|
# Configuration terms
|
||||||
|
xforwarded
|
||||||
|
PYTHONHTTPSVERIFY
|
||||||
|
|
||||||
|
# Keycloak-specific
|
||||||
|
ciba
|
||||||
|
clusterless
|
||||||
|
remembertochangeme
|
||||||
|
|
||||||
|
# Molecule / Testing
|
||||||
|
hspaans
|
||||||
|
|
||||||
|
# CI / DevOps
|
||||||
|
sangonzal
|
||||||
|
rootperm
|
||||||
|
|
||||||
|
# RST / Sphinx directives
|
||||||
|
toctree
|
||||||
|
|
||||||
|
# Task names / verbs
|
||||||
|
Reown
|
||||||
|
decomment
|
||||||
|
|
||||||
|
# British spellings (from upstream Keycloak docs)
|
||||||
|
recognises
|
||||||
|
|
||||||
|
# Other
|
||||||
|
rmaster
|
||||||
@@ -14,6 +14,18 @@ on:
|
|||||||
- cron: '15 6 * * *'
|
- cron: '15 6 * * *'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
spellcheck:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v7
|
||||||
|
|
||||||
|
- name: Run cspell
|
||||||
|
uses: streetsidesoftware/cspell-action@v9
|
||||||
|
with:
|
||||||
|
incremental_files_only: false
|
||||||
|
use_cspell_files: true
|
||||||
|
|
||||||
ci:
|
ci:
|
||||||
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
|
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
|
||||||
secrets: inherit
|
secrets: inherit
|
||||||
|
|||||||
+1
-1
@@ -10,7 +10,7 @@ Clone the repository, checkout the tag you want to build, or pick the main branc
|
|||||||
|
|
||||||
### Development environment
|
### Development environment
|
||||||
|
|
||||||
Make sure your development machine has avilable:
|
Make sure your development machine has available:
|
||||||
|
|
||||||
* python 3.11+
|
* python 3.11+
|
||||||
* virtualenv
|
* virtualenv
|
||||||
|
|||||||
+59
@@ -0,0 +1,59 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
|
||||||
|
"version": "0.2",
|
||||||
|
"language": "en",
|
||||||
|
"ignorePaths": ["changelogs/**", "CHANGELOG.rst"],
|
||||||
|
"files": [
|
||||||
|
"**/*.md",
|
||||||
|
"**/*.rst",
|
||||||
|
"roles/*/meta/argument_specs.yml",
|
||||||
|
"roles/*/meta/main.yml",
|
||||||
|
"roles/*/tasks/**/*.yml",
|
||||||
|
"roles/*/defaults/*.yml",
|
||||||
|
"roles/*/handlers/*.yml",
|
||||||
|
"roles/*/templates/*.j2",
|
||||||
|
"molecule/**/*.yml",
|
||||||
|
"molecule/**/*.j2",
|
||||||
|
"playbooks/**/*.yml",
|
||||||
|
"meta/runtime.yml",
|
||||||
|
"meta/execution-environment.yml",
|
||||||
|
".github/workflows/*.yml",
|
||||||
|
".github/ISSUE_TEMPLATE/*.md",
|
||||||
|
"galaxy.yml"
|
||||||
|
],
|
||||||
|
"dictionaries": [
|
||||||
|
"custom-keycloak",
|
||||||
|
"java",
|
||||||
|
"bash",
|
||||||
|
"shellscript",
|
||||||
|
"fullstack",
|
||||||
|
"softwareTerms",
|
||||||
|
"software-tools",
|
||||||
|
"cpp-compound-words",
|
||||||
|
"python",
|
||||||
|
"docker",
|
||||||
|
"k8s",
|
||||||
|
"html",
|
||||||
|
"css",
|
||||||
|
"git",
|
||||||
|
"networking-terms",
|
||||||
|
"node",
|
||||||
|
"npm"
|
||||||
|
],
|
||||||
|
"dictionaryDefinitions": [
|
||||||
|
{
|
||||||
|
"name": "custom-keycloak",
|
||||||
|
"path": ".cspell/custom-dictionary.txt",
|
||||||
|
"addWords": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"ignoreRegExpList": [
|
||||||
|
"/\\{\\{.*?\\}\\}/g",
|
||||||
|
"/`[^`]+`/g",
|
||||||
|
"/(https?:\\/\\/[^\\s)]+)/g",
|
||||||
|
"/\\|`?[a-z_]+`?\\|/g",
|
||||||
|
"/\\[.*?\\]\\(.*?\\)/g",
|
||||||
|
"/^\\s*authors?:.*$/gm",
|
||||||
|
"/^\\s*-\\s+.*<[^>]+>.*$/gm"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -24,4 +24,4 @@
|
|||||||
|
|
||||||
- name: Invalid providerIds in execution tests
|
- name: Invalid providerIds in execution tests
|
||||||
ansible.builtin.include_tasks:
|
ansible.builtin.include_tasks:
|
||||||
file: tests/test_invalid_poviderid_flow_creation.yml
|
file: tests/test_invalid_providerid_flow_creation.yml
|
||||||
@@ -36,7 +36,7 @@
|
|||||||
ansible.builtin.set_fact:
|
ansible.builtin.set_fact:
|
||||||
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
|
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
|
||||||
|
|
||||||
- name: "Download artefacts only if assets_server is set"
|
- name: "Download artifacts only if assets_server is set"
|
||||||
when:
|
when:
|
||||||
- assets_server is defined
|
- assets_server is defined
|
||||||
- assets_server | length > 0
|
- assets_server | length > 0
|
||||||
|
|||||||
@@ -116,7 +116,7 @@ Role Defaults
|
|||||||
|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}` |
|
|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}` |
|
||||||
|`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `false` |
|
|`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` | 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_validation_millis`| How frequently 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_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/` |
|
|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
|
||||||
|`keycloak_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` |
|
|`keycloak_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` |
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ keycloak_features: []
|
|||||||
keycloak_ha_enabled: false
|
keycloak_ha_enabled: false
|
||||||
### Enable database configuration, must be enabled when HA is configured
|
### Enable database configuration, must be enabled when HA is configured
|
||||||
keycloak_db_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
keycloak_db_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
||||||
### Discovery protocol for ha cluster members, valus [ 'JDBC_PING', 'TCPPING' ]
|
### Discovery protocol for ha cluster members, values [ 'JDBC_PING', 'TCPPING' ]
|
||||||
keycloak_ha_discovery: "{{ 'JDBC_PING' if keycloak_db_enabled else 'TCPPING' }}"
|
keycloak_ha_discovery: "{{ 'JDBC_PING' if keycloak_db_enabled else 'TCPPING' }}"
|
||||||
### Remote cache store on infinispan cluster
|
### Remote cache store on infinispan cluster
|
||||||
keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
||||||
|
|||||||
@@ -296,7 +296,7 @@ argument_specs:
|
|||||||
type: "bool"
|
type: "bool"
|
||||||
keycloak_db_background_validation_millis:
|
keycloak_db_background_validation_millis:
|
||||||
default: "{{ 10000 if keycloak_db_background_validation else 0 }}"
|
default: "{{ 10000 if keycloak_db_background_validation else 0 }}"
|
||||||
description: "How frequenly the connection pool is validated in the background"
|
description: "How frequently the connection pool is validated in the background"
|
||||||
type: 'int'
|
type: 'int'
|
||||||
keycloak_db_background_validate_on_match:
|
keycloak_db_background_validate_on_match:
|
||||||
default: false
|
default: false
|
||||||
|
|||||||
@@ -88,7 +88,7 @@ Role Defaults
|
|||||||
|`keycloak_quarkus_systemd_wait_for_delay`| Activation delay for service systemd unit (seconds) | `10` |
|
|`keycloak_quarkus_systemd_wait_for_delay`| Activation delay for service systemd unit (seconds) | `10` |
|
||||||
|`keycloak_quarkus_restart_strategy`| Strategy task file for restarting in HA (one of provided restart/['serial.yml','none.yml','serial_then_parallel.yml']) or path to file when providing custom strategy | `restart/serial.yml` |
|
|`keycloak_quarkus_restart_strategy`| Strategy task file for restarting in HA (one of provided restart/['serial.yml','none.yml','serial_then_parallel.yml']) or path to file when providing custom strategy | `restart/serial.yml` |
|
||||||
|`keycloak_quarkus_restart_health_check`| Whether to wait for successful health check after restart | `true` |
|
|`keycloak_quarkus_restart_health_check`| Whether to wait for successful health check after restart | `true` |
|
||||||
|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting healch checks | `10` |
|
|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting health checks | `10` |
|
||||||
|`keycloak_quarkus_restart_health_check_retries`| Number of attempts for successful health check before failing | `25` |
|
|`keycloak_quarkus_restart_health_check_retries`| Number of attempts for successful health check before failing | `25` |
|
||||||
|`keycloak_quarkus_validate_certs`| Whether to validate SSL certificates when performing health checks | `true` |
|
|`keycloak_quarkus_validate_certs`| Whether to validate SSL certificates when performing health checks | `true` |
|
||||||
|`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` |
|
|`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` |
|
||||||
|
|||||||
@@ -95,7 +95,7 @@ keycloak_quarkus_hostname:
|
|||||||
keycloak_quarkus_hostname_admin: ""
|
keycloak_quarkus_hostname_admin: ""
|
||||||
|
|
||||||
### Set the path relative to / for serving resources. The path must start with a /
|
### Set the path relative to / for serving resources. The path must start with a /
|
||||||
### (set to `/auth` for retrocompatibility with pre-quarkus releases)
|
### (set to `/auth` for backward compatibility with pre-quarkus releases)
|
||||||
keycloak_quarkus_http_relative_path: /
|
keycloak_quarkus_http_relative_path: /
|
||||||
|
|
||||||
# Disables dynamically resolving the hostname from request headers.
|
# Disables dynamically resolving the hostname from request headers.
|
||||||
|
|||||||
@@ -482,7 +482,7 @@ argument_specs:
|
|||||||
default: 15
|
default: 15
|
||||||
type: int
|
type: int
|
||||||
keycloak_quarkus_restart_health_check_delay:
|
keycloak_quarkus_restart_health_check_delay:
|
||||||
description: "Seconds to let pass before starting healch checks"
|
description: "Seconds to let pass before starting health checks"
|
||||||
default: 10
|
default: 10
|
||||||
type: 'int'
|
type: 'int'
|
||||||
keycloak_quarkus_restart_health_check_retries:
|
keycloak_quarkus_restart_health_check_retries:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
- name: "Restart services in serial, with optional healtch check (keycloak_quarkus_restart_health_check)"
|
- name: "Restart services in serial, with optional health check (keycloak_quarkus_restart_health_check)"
|
||||||
throttle: 1
|
throttle: 1
|
||||||
block:
|
block:
|
||||||
- name: "Restart and enable service: {{ keycloak.service_name }}"
|
- name: "Restart and enable service: {{ keycloak.service_name }}"
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ keycloak_realm_clients: []
|
|||||||
# list of roles to create in the client
|
# list of roles to create in the client
|
||||||
keycloak_realm_client_default_roles: []
|
keycloak_realm_client_default_roles: []
|
||||||
|
|
||||||
# if True, create a public client; otherwise, a confidetial client
|
# if True, create a public client; otherwise, a confidential client
|
||||||
keycloak_realm_client_public: true
|
keycloak_realm_client_public: true
|
||||||
|
|
||||||
# allowed web origins for the client
|
# allowed web origins for the client
|
||||||
|
|||||||
Reference in New Issue
Block a user