Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Improve the host field description to make the default value more clear #10073

Merged
merged 2 commits into from
May 8, 2024
Merged

[DOC] Improve the host field description to make the default value more clear #10073

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c852dd5
Improve the host field description to make the default valeu more clear
scholzj May 7, 2024
4901bbf
Review comments PM
scholzj May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api/src/main/java/io/strimzi/api/kafka/model/user/acl/AclRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ public void setResource(AclRuleResource resource) {
this.resource = resource;
}

@Description("The host from which the action described in the ACL rule is allowed or denied.")
@Description("The host from which the action described in the ACL rule is allowed or denied. " +
"If not set, it defaults to `*` and the action will be allowed or denied from any host.")
scholzj marked this conversation as resolved.
Show resolved Hide resolved
@JsonProperty(defaultValue = "*")
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
public String getHost() {
Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/appendix_crds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3141,7 +3141,7 @@ include::../api/io.strimzi.api.kafka.model.user.acl.AclRule.adoc[leveloffset=+1]
|Indicates the resource for which given ACL rule applies.
|host
|string
|The host from which the action described in the ACL rule is allowed or denied.
|The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host.
|operation
|string (one of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs])
|**The `operation` property has been deprecated, and should now be configured using `spec.authorization.acls[*].operations`.** Operation which will be allowed or denied. Supported operations are: Read, Write, Create, Delete, Alter, Describe, ClusterAction, AlterConfigs, DescribeConfigs, IdempotentWrite and All.
Expand Down
6 changes: 3 additions & 3 deletions packaging/helm-charts/helm3/strimzi-kafka-operator/crds/044-Crd-kafkauser.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down Expand Up @@ -361,7 +361,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down Expand Up @@ -592,7 +592,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down
6 changes: 3 additions & 3 deletions packaging/install/cluster-operator/044-Crd-kafkauser.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down Expand Up @@ -360,7 +360,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down Expand Up @@ -591,7 +591,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down
6 changes: 3 additions & 3 deletions packaging/install/user-operator/04-Crd-kafkauser.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down Expand Up @@ -360,7 +360,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down Expand Up @@ -591,7 +591,7 @@ spec:
description: Indicates the resource for which given ACL rule applies.
host:
type: string
description: The host from which the action described in the ACL rule is allowed or denied.
description: "The host from which the action described in the ACL rule is allowed or denied. If not set, it defaults to `*` and the action will be allowed or denied from any host."
operation:
type: string
enum:
Expand Down
Loading