Skip to main content

Get application component runtime configuration

GET 
/applications/:applicationId/components/:applicationComponentId/runtime-config


Retrieves the runtime configuration detail for given component. Either (build) version or (git) branch must be provided as query parameter to specify the requested runtime configuration version.

Request​

Path Parameters

    applicationId stringrequired

    Possible values: non-empty

    applicationComponentId stringrequired

    Possible values: non-empty

Query Parameters

    version string
    branch string

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

200 response

Schema

    runtimeConfig

    object

    required


    An object containing the runtime configuration of the application component. It represents the configuration file .codenow.config.yaml.

    replicas int32required

    Possible values: >= 1 and <= 40


    The number of instances (containers) of this application component run in parallel. Minimum value is 1, maximum value is 40.

    resources

    object

    required


    An object specifying the minimum required and maximum allowed resources (CPU and memory) needed by the containers running this application component.

    limits

    object


    The maximum allowed resource allocation (CPU and memory) to the containers running this application component.
    If some of the values are omitted, it means they are not set.

    cpu stringnullable

    Possible values: non-empty


    The maximum allowed CPU allocation for the containers running this application component.
    It accepts two possible units: cpu (cpu core), represented by a simple number (decimals allowed), and m (thousandth of a core), denoted by the 'm' suffix. For example, '1000m' is equivalent to '1'.
    The value must not be less than 1m (0.001).

    memory stringnullable

    Possible values: non-empty


    The maximum allowed memory allocation for the container running this application component in bytes.
    You can express the value as a plain integer, a number in exponential format or as a fixed-point number using one of these quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following represent roughly the same value: 128974848, 129e6, 129M, 128974848000m, 123Mi.
    The value must not be less than 1k (1000 bytes).

    requests

    object


    The required resources (CPU and memory) needed by the containers running this application component.
    If some of the values are omitted, it means they are not set.

    cpu stringnullable

    Possible values: non-empty


    The required CPU allocation for the containers running this application component.
    It accepts two possible units: cpu (cpu core), represented by a simple number (decimals allowed), and m (thousandth of a core), denoted by the 'm' suffix. For example, '1000m' is equivalent to '1'.
    The value must not be less than 1m (0.001).
    The value must be less than or equal to the CPU limit value.

    memory stringnullable

    Possible values: non-empty


    The required memory allocation for the containers running this application component in bytes.
    You can express the value as a plain integer, a number in exponential format or as a fixed-point number using one of these quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following represent roughly the same value: 128974848, 129e6, 129M, 128974848000m, 123Mi.
    The value must not be less than 1k (1000 bytes).
    The value must be less than or equal to the memory limit value.

    present booleanrequired


    A boolean flag indicating whether the configuration file .codenow.config.yaml containing the runtime configuration exists in this component's repository.
    If set to false, default runtime configuration is used.

Loading...