Skip to main content

Update CI config

PUT 
/applications/:applicationId/components/:componentId/ci-config

The operation allows you to update CI config of a specific application component and branch.

Request​

Path Parameters

    applicationId stringrequired

    Possible values: non-empty

    componentId stringrequired

    Possible values: non-empty

Query Parameters

    branch stringrequired

    Possible values: non-empty

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Body

required

    advancedMode

    object


    The field plays a crucial role in determining the build behavior within your CI pipelines.
    When enabled, advanced mode empowers developers with greater control and flexibility over their build
    processes by allowing them to utilize pre-existing Dockerfiles and Helm charts stored in their Git repositories.

    enabled booleanrequired


    A boolean flag indicating enablement of application component advanced mode.

    build

    object


    The build section encompasses fields dedicated to configuring Continuous Integration (CI) pipelines themselves.
    These settings allow users to define the environment variables, build container, and instance of pipeline necessary for building
    artifacts seamlessly within their development workflows.

    image string


    The field specifies the container utilized for executing build
    and unit test tasks within the Continuous Integration (CI) pipeline.

    environmentVariables

    object[]


    The environmentVariables section configures custom environment variables
    that are utilized within the Continuous Integration (CI) pipeline.

  • Array [

    • name stringrequired

    Possible values: non-empty


    The name of the environment variable.

    value stringrequired

    Possible values: non-empty


    The value of the environment variable.

  • ]

    • pipelines

    object


    The pipelines section defines and configures the specific pipelines
    to be executed for release builds and preview builds.

    preview string


    Defines the pipeline id for performed preview builds.
    Available pipelines can be obtained through the /ci-pipelines endpoint.

    release string


    Defines the pipeline id for performed release builds.
    Available pipelines can be obtained through the /ci-pipelines endpoint.

    runtime

    object


    The runtime section offers a range of fields that enable developers to customize the behavior of runtime artifacts created in CI pipelines.
    These artifacts, such as Docker images or Helm charts, are essential components of the deployment process and directly influence the behavior of deployed applications.
    The settings in the section is used only if the advancedMode is disabled.

    image string


    The base image the will be used for templating on-the-fly generated Dockerfile.

    port string


    The field specifies the port used by their application or process inside the container built during CI pipelines.
    This port information is crucial for generating on-the-fly Helm charts, ensuring correct routing and networking configurations
    when deploying applications to Kubernetes clusters.

    endpoints

    object


    The endpoints section influences the exposure of components within a Kubernetes cluster.

    external

    object


    The external section configures the behavior of exposing services outside the Kubernetes cluster.

    enabled booleanrequired


    The field determines whether a service will be exposed outside of the Kubernetes cluster.

    java

    object


    The java section sets parameters for the Java process running inside the container that is result of CI pipeline.

    jvmParameters stringrequired

    Possible values: non-empty


    The field sets up JVM (Java Virtual Machine) parameters for the Java process running inside the container that is result of CI pipeline.

Responses​

CI config detail

Schema

    status stringrequired

    Possible values: non-empty

Loading...