Management API Reference for subsystem=microprofile-health-smallrye

WildFly Extension for MicroProfile Health With SmallRye

Provided Capabilities (3)

Name	Dynamic	Other provider points
org.wildfly.extension.microprofile.health.http-context	false	none
org.wildfly.extension.health.http-context.security-enabled	false	none
org.wildfly.extension.microprofile.health.reporter	false	none

Attributes (4)

empty-liveness-checks-status - Defines the global status returned by the Health checks endpoints if no liveness probes have been defined in deployments.

Type	STRING
Default Value	UP
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	DOWN UP
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the global status returned by the Health checks endpoints if no liveness probes have been defined in deployments.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "UP", "allowed" : [ "UP", "DOWN" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

empty-readiness-checks-status - Defines the global status returned by the Health checks endpoints if no readiness probes have been defined in deployments.

Type	STRING
Default Value	UP
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	DOWN UP
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the global status returned by the Health checks endpoints if no readiness probes have been defined in deployments.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "UP", "allowed" : [ "UP", "DOWN" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

empty-startup-checks-status - Defines the global status returned by the Health checks endpoints if no startup probes have been defined in deployments.

Type	STRING
Default Value	UP
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	DOWN UP
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the global status returned by the Health checks endpoints if no startup probes have been defined in deployments.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "UP", "allowed" : [ "UP", "DOWN" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

security-enabled - True if authentication is required to access the HTTP endpoints on the HTTP management interface.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "True if authentication is required to access the HTTP endpoints on the HTTP management interface.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add the subsystem

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
empty-liveness-checks-status	STRING	false	true	UP	Defines the global status returned by the Health checks endpoints if no liveness probes have been defined in deployments.
empty-readiness-checks-status	STRING	false	true	UP	Defines the global status returned by the Health checks endpoints if no readiness probes have been defined in deployments.
empty-startup-checks-status	STRING	false	true	UP	Defines the global status returned by the Health checks endpoints if no startup probes have been defined in deployments.
security-enabled	BOOLEAN	false	true	true	True if authentication is required to access the HTTP endpoints on the HTTP management interface.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the subsystem",
    "request-properties" : {
        "empty-liveness-checks-status" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the global status returned by the Health checks endpoints if no liveness probes have been defined in deployments.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "UP",
            "allowed" : [
                "UP",
                "DOWN"
            ],
            "stability" : "default"
        },
        "empty-readiness-checks-status" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the global status returned by the Health checks endpoints if no readiness probes have been defined in deployments.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "UP",
            "allowed" : [
                "UP",
                "DOWN"
            ],
            "stability" : "default"
        },
        "empty-startup-checks-status" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the global status returned by the Health checks endpoints if no startup probes have been defined in deployments.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "UP",
            "allowed" : [
                "UP",
                "DOWN"
            ],
            "stability" : "default"
        },
        "security-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True if authentication is required to access the HTTP endpoints on the HTTP management interface.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the subsystem

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the subsystem",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.microprofile-health-smallrye

        
<feature spec="subsystem.microprofile-health-smallrye">
  <param name="empty-liveness-checks-status" value="{value}"/>
  <param name="empty-readiness-checks-status" value="{value}"/>
  <param name="empty-startup-checks-status" value="{value}"/>
  <param name="security-enabled" value="{value}"/>
<feature/>