Package io.fabric8.openshift.api.model.config.v1

Class Audit

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<AuditBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Audit
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<AuditBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    See Also:
    Serialized Form

    • Constructor Detail

      • Audit

        public Audit()
        No args constructor for use in serialization

    • Method Detail

      • getCustomRules

        public List<AuditCustomRule> getCustomRules()
        customRules specify profiles per group. These profile take precedence over the top-level profile field if they apply. They are evaluation from top to bottom and the first one that matches, applies.

      • setCustomRules

        public void setCustomRules​(List<AuditCustomRule> customRules)
        customRules specify profiles per group. These profile take precedence over the top-level profile field if they apply. They are evaluation from top to bottom and the first one that matches, applies.

      • getProfile

        public String getProfile()
        profile specifies the name of the desired top-level audit profile to be applied to all requests sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver, openshift-apiserver and oauth-apiserver), with the exception of those requests that match one or more of the customRules.


        The following profiles are provided: - Default: default policy which means MetaData level logging with the exception of events

        (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody

        level).

        - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.


        Warning: It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly.


        If unset, the 'Default' profile is used as the default.

      • setProfile

        public void setProfile​(String profile)
        profile specifies the name of the desired top-level audit profile to be applied to all requests sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver, openshift-apiserver and oauth-apiserver), with the exception of those requests that match one or more of the customRules.


        The following profiles are provided: - Default: default policy which means MetaData level logging with the exception of events

        (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody

        level).

        - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.


        Warning: It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly.


        If unset, the 'Default' profile is used as the default.

      • edit

        public AuditBuilder edit()
        Specified by:
        edit in interface io.fabric8.kubernetes.api.builder.Editable<AuditBuilder>

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)