Deployments

Each function can have many deployments, which can be thought of as versions of the mini-application. Functions can be created and deployed in different ways to meet your unique development habits.

Deployment status

Throughout the life cycle of a deployment, it could have the following status.

Update deployment

Some Function settings require redeploying your function to be reflected in your active deployment. When you update a function by changing it's Git settings, Build settings, and Environment variables, you need to redeploy your function before they take effect.

Build logs

When you build a deployment, the logs generated will be saved for debugging purposes. You can find build logs by navigating to the deployments tab of your function, clicking the three-dots menu beside, and click Logs.

Redeploy

After updating the configuration, redeploy your function for changes to take effect. You can also redeploy to retry failed builds.

1. Navigate to Functions.
2. Open the function you wish to inspect.
3. Under the Deployments tab, find the status of the current active deployment.
4. Redeploy by clicking the triple-dots beside an execution, and hitting the Redeploy button.

Redeployment behavior varies depending on how the initial deployment was created.

Deployment retention

Deployment retention controls how long Appwrite keeps non-active function deployments. The active deployment is always kept. When a non-active deployment is older than the configured retention period, Appwrite automatically deletes it during maintenance. Set the value to 0 to keep non-active deployments forever.

To configure deployment retention from the Appwrite Console:

1. Navigate to Functions.
2. Open the function you want to configure.
3. Go to Settings > Deployment retention.
4. Turn on Keep deployments forever, or turn it off and choose how long to keep non-active deployments.
5. Click Update.

The Console provides common presets from 1 Week to 10 Years. When using the API or a Server SDK, set deploymentRetention to the number of days to keep non-active deployments. The value must be between 0 and 36500, where 0 means unlimited retention.

When updating a function with a Server SDK, pass the existing settings you do not intend to change and update only deploymentRetention.

const func = await functions.get({
    functionId: '<FUNCTION_ID>'
});

await functions.update({
    functionId: func.$id,
    name: func.name,
    runtime: func.runtime,
    execute: func.execute ?? undefined,
    events: func.events ?? undefined,
    schedule: func.schedule ?? undefined,
    timeout: func.timeout ?? undefined,
    enabled: func.enabled ?? undefined,
    logging: func.logging ?? undefined,
    entrypoint: func.entrypoint ?? undefined,
    commands: func.commands ?? undefined,
    scopes: func.scopes ?? undefined,
    installationId: func.installationId ?? undefined,
    providerRepositoryId: func.providerRepositoryId ?? undefined,
    providerBranch: func.providerBranch ?? undefined,
    providerSilentMode: func.providerSilentMode ?? undefined,
    providerRootDirectory: func.providerRootDirectory ?? undefined,
    buildSpecification: func.buildSpecification ?? undefined,
    runtimeSpecification: func.runtimeSpecification ?? undefined,
    deploymentRetention: 90
});