Skip to content

Commit

Permalink
fix(docs): update docs for groups
Browse files Browse the repository at this point in the history
  • Loading branch information
tchiotludo committed Dec 8, 2020
1 parent 7bd08d7 commit 09e35de
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ out/*
logs/*

### Kafka HQ ###
src/main/*-*.yml
src/main/*/*-*.yml
connects-plugins/

### Docs
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,8 +372,9 @@ Groups allow you to limit user
Define groups with specific roles for your users
* `akhq.security.default-group`: Default group for all the user even unlogged user

* `akhq.security.groups`: Groups list definition
* `- name: group-name` Group identifier
* `akhq.security.groups`: Groups map definition
* `key:` a uniq key used as name if not specified
* ` name: group-name` Group identifier
* `roles`: Roles list for the group
* `attributes.topics-filter-regexp`: Regexp to filter topics available for current group
* `attributes.connects-filter-regexp`: Regexp to filter Connect tasks available for current group
Expand Down Expand Up @@ -480,14 +481,16 @@ Configure AKHQ groups and Ldap groups and users
akhq:
security:
groups:
- name: topic-reader # Group name
topic-reader:
name: topic-reader # Group name
roles: # roles for the group
- topic/read
attributes:
# Regexp to filter topic available for group
topics-filter-regexp: "test\\.reader.*"
connects-filter-regexp: "^test.*$"
- name: topic-writer # Group name
topic-writer:
name: topic-writer # Group name
roles:
- topic/read
- topic/insert
Expand Down Expand Up @@ -787,4 +790,4 @@ Many thanks to:
## License
Apache 2.0 © [tchiotludo](https://github.com/tchiotludo)
Apache 2.0 © [tchiotludo](https://github.com/tchiotludo)
6 changes: 4 additions & 2 deletions application.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,8 @@ akhq:
default-group: admin # Default groups for all the user even unlogged user
# Groups definition
groups:
- name: admin # Group name
admin: # unique key
name: admin # Group name
roles: # roles for the group
- topic/read
- topic/insert
Expand Down Expand Up @@ -195,7 +196,8 @@ akhq:
topics-filter-regexp: "test.*"
# Regexp to filter connect configs visible for group
connects-filter-regexp: "^test.*$"
- name: topic-reader # Other group
topic-reader: # unique key
name: topic-reader # Other group
roles:
- topic/read
attributes:
Expand Down

0 comments on commit 09e35de

Please sign in to comment.