circleci · rosieyohannan · Apr 2, 2025 · Mar 31, 2025 · Mar 31, 2025 · Mar 31, 2025
@@ -782,7 +782,7 @@ jobs:
       ... // other config
 ----
 
-Jobs with the `release` type are used to xref:deploy/configure-your-kubernetes-components#link-release[connect your pipeline configuration] to a release in the CircleCI releases UI. For full details, see the xref:deploy/deploys-overview#[Releases overview] page.
+Jobs with the `release` type are used to xref:deploy/configure-your-kubernetes-components#link-release[connect your pipeline configuration] to a deployment in the CircleCI deploys UI. For full details, see the xref:deploy/deploys-overview#[Deploys overview] page.
 
 **Example** of a job with a `release` type:
 

@@ -5,17 +5,17 @@ contentTags:
 ---
 = Deploy to Amazon SageMaker
 :page-layout: classic-docs
-:page-description: A guide to configuring deployments to Amazon SageMaker and monitoring in the CircleCI releases UI.
+:page-description: A guide to configuring deployments to Amazon SageMaker and monitoring in the CircleCI deploys UI.
 :icons: font
 :experimental:
 
 NOTE: The link:https://circleci.com/developer/orbs/orb/circleci/aws-sagemaker[SageMaker orb] is in **open preview**.
 
-This how-to guide walks you through the steps to set up and use the Amazon SageMaker orb to deploy and release models to SageMaker. It uses the sample repository link:https://github.com/CircleCI-Public/sagemaker-deploy-examples#[example project repository] as a reference, but you can adapt every step to your requirements. Through this guide, you will learn how to orchestrate model deployment to endpoints across different environments, as well as track and manage your releases in the CircleCI release UI.
+This how-to guide walks you through the steps to set up and use the Amazon SageMaker orb to deploy and release models to SageMaker. It uses the sample repository link:https://github.com/CircleCI-Public/sagemaker-deploy-examples#[example project repository] as a reference, but you can adapt every step to your requirements. Through this guide, you will learn how to orchestrate model deployment to endpoints across different environments, as well as track and manage your deployments in the CircleCI deploys UI.
 
-For further information about the orb and the releases feature see the following:
+For further information about the orb and the CircleCI deploys feature see the following:
 
-* xref:deploy/deploys-overview#[Releases overview]
+* xref:deploy/deploys-overview#[Deploys overview]
 * link:https://circleci.com/developer/orbs/orb/circleci/aws-sagemaker[Amazon SageMaker orb]
 * link:https://circleci.com/blog/amazon-sagemaker-deployment-orchestration/[**Blog post**: Using Amazon SageMaker orb to orchestrate model deployment across environments]
 
@@ -31,22 +31,15 @@ To follow along with this how-to guide you will need the following:
 * A copy of the link:https://github.com/CircleCI-Public/sagemaker-deploy-examples[example repository] building on CircleCI. For steps to get the project set up, see the xref:create-project#[Create a project in CircleCI] page.
 
 [#set-up-a-circleci-release-environment]
-== 1. Set up a CircleCI release environment
+== 1. Set up a CircleCI environment integration
 
-First, set up a release environment to monitor your releases from the CircleCI web app, and access options to manage promotions and rollbacks.
+First, set up an environment integration to monitor your deployments from the CircleCI web app, and access options to manage promotions and rollbacks.
 
-. In the CircleCI web app, select **Releases** from the sidebar
-. If this is your first release environment, you will see an option to btn:[Add Release Environment]. If not, Click btn:[Configure Environments] in the top right corner, and then click btn:[Configure New Environment]
+. In the CircleCI web app, select **Deploys** from the sidebar
+. If this is your first environment integration, you will see an option to btn:[Create your first environment integration]. If not, select the "Environments" tab, and then select btn:[Create Environment Integration]
 +
-image::deploy/add-release-environment.png[Screenshot showing option to add a new release environment]
-. In the popup, select **Amazon SageMaker** from the "Environment" dropdown. Give your new environment a name, and click btn:[Create Environment]
-+
-image::deploy/create-new-environment.png[Screenshot showing new release environment popup]
-. Select your new environment name to enter the environment view.
-. Select btn:[Create New Token].
-+
-image::deploy/release-create-new-token.png[Screenshot showing create new token button]
-. Select btn:[Create Token]. Be sure to save this token, you will create an environment variable later to store it.
+image::deploy/add-release-environment.png[Screenshot showing option to add a new environment integration]
+. In the popup, select **Amazon SageMaker** from the "Type" dropdown. Follow the instructions on screen to generate and save a token.
 
 [#set-up-amazon-sagemaker-access]
 == 2. Set up Amazon SageMaker access
@@ -347,19 +340,16 @@ Next, is an approval job. This stops the workflow from deploying to production u
 image::deploy/job-approval.png[Approval job]
 
 [#check-in-on-your-release]
-== 7. Check in on your release
+== 7. Check in on your deployment
 
-The CircleCI release UI offers you a single pane of glass to monitor all your deployments across environments. You can view deployment progress in real time, see what versions are currently deployed, and navigate to the SageMaker console. If you navigate to the releases dashboard by clicking **Releases** in the web app sidebar, you should now see something along the lines of the image below:
+The CircleCI deploys UI offers you a single pane of glass to monitor all your deployments across environments. You can view deployment progress in real time, see what versions are currently deployed, and navigate to the SageMaker console. If you navigate to the deploys dashboard by clicking **Deploys** in the web app sidebar, you should now see something along the lines of the image below:
 
-image::deploy/sagemaker-releases.png[Releases dashboard]
+image::deploy/sagemaker-releases.png[Deploys dashboard]
 
 Select the component name to view details about the component, including the number of instances deployed. From this interface, you can navigate to Amazon SageMaker for live information on your endpoint.
 
-image::deploy/sagemaker-component-view.png[Releases component view]
-
-Select the version to see the version details page for version being released. Clicking on specific versions lets you monitor release progress in real-time.
+image::deploy/sagemaker-component-view.png[Deploys component view]
 
-image::deploy/wait-for-availability.png[Releases version view]
+Select the version to see the details page for the version being deployed. Clicking on a specific version lets you monitor deployment progress in real-time.
 
-[#conclusion]
-== Conclusion
+image::deploy/wait-for-availability.png[Deploys version view]
@@ -43,7 +43,7 @@ To get set up with deploys for Amazon SageMaker, refer to the xref:../deploy-to-
 
 CircleCI integrates with your Kubernetes cluster to give you visibility and control over your release process through the CircleCI web app. We currently support Kubernetes Deployments and Argo Rollouts.
 
-image::../../img/docs/releases/releases-architecture.png[Diagram showing the architecture of CircleCI releases]
+image::../../img/docs/releases/releases-architecture.png[Diagram showing the architecture of CircleCI deploys]
 
 Configure environment integrations to install the CircleCI release agent into your Kubernetes clusters. Configure the release agent to only monitor the namespaces you require.
 
@@ -100,7 +100,7 @@ In the deploys dashboard, deployments are tagged as **Progressive** if they refe
 
 A deployment starts when the component version is updated, and ends when the new version has reached 100% availability, and all associated validations have been completed. In the case of a progressive deployment, this happens when the Rollout completes. In the case of a Kubernetes Deployment, this happens when the Deployment replicas are all available and ready.
 
-[#the-releases-UI]
+[#the-deploys-UI]
 == The deploys UI
 
 The CircleCI deploys UI is a powerful tool for visualising, monitoring and managing your deployments. The pages included in the deploys UI are described below.
@@ -112,8 +112,8 @@ image::../../img/docs/releases/dashboard.png[Screenshot showing the deploys dash
 
 Select **Deploys** in the CircleCI web app sidebar to enter the deploys dashboard. The dashboard shows the following:
 
-* **Timeline**: A timeline of deploys across your organization's components and environments. You can use the filter dropdown menus at the top of the page to select a component and/or environment. You will see live status updates, deployment trigger source, release version, deployment type (for example, _progressive_, when you are using an Argo Rollout). From here you can access the following:
-** The deployment details page for a specific release by clicking on the status badge or version number.
+* **Timeline**: A timeline of deploys across your organization's components and environments. You can use the filter dropdown menus at the top of the page to select a component and/or environment. You will see live status updates, deployment trigger source, deployment version version, deployment type (for example, _progressive_, when you are using an Argo Rollout). From here you can access the following:
+** The deployment details page for a specific deployment by clicking on the status badge or version number.
 ** The component or environment details pages by clicking on the respective names.
 ** The project dashboard for the CircleCI project associated with a deployment.
 ** The job details page for the job that started the deployment.
@@ -286,21 +286,21 @@ The following table shows a complete list of labels and annotations either requi
 |No. Only set if you want to disable the cancel deployment feature for your component.
 |===
 
-== Autodetected deployments and deploy markers
+== Automatic deployment detection and deploy markers
 
 CircleCI automatically generates deploy markers for your deployment pipelines. Deploy markers provide a lightweight way to log your deployments without requiring a full CircleCI deploys setup. Deploy markers generate a log of all deployments in one place, for a clear overview of what has changed, without the need to search through your CI/CD pipelines. Deploy markers log all new deployments in one place and link back to the CI/CD pipelines that caused them. You can use deploy markers independently, without installing the CircleCI release agent.
 
-=== Auto-detection of deployments
+=== Automatic detection of deployments
 
-CircleCI looks for the word `deploy` in your job names to detect when a deployment may have happened and creates an autodetected deploy marker.
+CircleCI looks for the word `deploy` in your job names to detect when a deployment may have happened and creates an auto-detected deploy marker.
 
 When CircleCI creates a deploy marker for you automatically, we use the information available in your pipeline configuration to create the following:
 
 * **Component**: CircleCI created a component for the deployment and uses your project name to create a component name.
 * **Environment integration**: CircleCI creates an environment for you, using your job and workflow names to attempt to create a relevant name. If an environment name cannot be generated, the name will be `autogenerated`, and you can edit it later. The environment has the type `AUTODETECTED`.
 * **Version**: CircleCI uses the build number to populate the version for the purposes of displaying the deployment in the CircleCI web app.
 
-If any of the following conditions are true, CircleCI **will not** generate a deploy marker for a job even if the name contains the word `deploy`:
+If any of the following conditions are true, CircleCI **will not** automatically generate a deploy marker for a job even if the name contains the word `deploy`:
 
 * The job has a status other than `SUCCESS`.
 * Any of the following keywords and keyword combinations are present in the job name:
@@ -310,52 +310,52 @@ If any of the following conditions are true, CircleCI **will not** generate a de
 ** `deployed`
 ** `validation`
 ** `validate`
-* The project related to the job has releases created via the Kubernetes release agent or manual release jobs in the last two months.
-* You have opted out of the autodetected releases feature.
+* The project related to the job has deployments created via the Kubernetes release agent or manual release-type jobs in the last two months.
+* You have opted out of the automatic deploy detection feature.
 * The detected environment integration name collides with an integration you have already set up.
 
-==== Manual configuration of autodetected releases
-Some points to consider when manually configuring autodetected releases:
+==== Manual configuration of automatically detected deploys
+Some points to consider when manually configuring an automatically detected deploy are as follows:
 
-* If you decide you would like to manually configure a release marker for an environment integration that was created as part of an autodetected release, refer to the xref:configure-deploy-markers#[Configure release markers] page to set up a release marker and a new environment integration.
+* If you decide you would like to manually configure a deploy marker for an environment integration that was created as part of an automatically detected deploy, refer to the xref:configure-deploy-markers#[Configure deploy markers] page to set up a deploy marker and a new environment integration.
 
-* If you change a component name that was originally autodetected by us, CircleCI creates a new component and the history **will not** carry over. If you do not update the component name, the history **will** carry over.
+* If you change a component name that was originally autodetected by CircleCI, we create a new component and the history **will not** carry over. If you do not update the component name, the history **will** carry over.
 
 * If your environment integration has an autogenerated name, you can edit the name as follows:
 .. In the link:https://circleci.com/app/home[CircleCI web app], select your organization.
-.. Select **Releases** in the sidebar.
+.. Select **Deploys** in the sidebar.
 .. Select the **Environments** tab.
 .. Find your environment and select cog icon (icon:cog[]) to enter the environment integration settings page.
 .. Select **Edit**.
 .. Enter a new name and select btn:[Update].
 
 
-=== Opt out of autodetected releases
-If you do not want CircleCI to automatically create release marker for you, you can opt out of this feature either for a whole organization or per-project.
+=== Opt out of automatic deploy detection
+If you do not want CircleCI to automatically create deploy markers for you, you can opt out of this feature either for a whole organization or per-project.
 
-To opt out of autodetected releases for an entire **organization**, follow these steps:
+To opt out of automatic deploy detection for an entire **organization**, follow these steps:
 
 . In the link:https://circleci.com/app/home[CircleCI web app], select your organization.
 . Select **Organization settings** in the sidebar.
-. Select **Releases**.
-. Toggle the "Enable automatic release marker detection" option left. You will see a confirmation message in the bottom right hand corner of the app. To re-enable the feature, toggle the option right.
+. Select **Deploys**.
+. Toggle the "Enable automatic deploy marker detection" option left. You will see a confirmation message in the bottom right hand corner of the app. To re-enable the feature, toggle the option to the right.
 
-To opt out of autodetected releases for a **project**, follow these steps:
+To opt out of automatic deploy detection for a **project**, follow these steps:
 
 . In the link:https://circleci.com/app/home[CircleCI web app], select your organization.
 . Select **Projects** in the sidebar.
 . Find your project in the list, select the ellipsis (icon:ellipsis-h[]), select **Project Settings**.
-. Select **Releases**.
-. Toggle the "Enable automatic release marker detection" option left. You will see a confirmation message in the bottom right hand corner of the app. To re-enable the feature, toggle the option right.
+. Select **Deploys**.
+. Toggle the "Enable automatic deploy marker detection" option left. You will see a confirmation message in the bottom right hand corner of the app. To re-enable the feature, toggle the option to the right.
 
-=== Manual setup of release markers
+=== Manual deploy marker setup
 
-If you would rather set up release markers yourself, see the xref:configure-deploy-markers#[Configure release markers] page.
+If you would rather set up deploy markers yourself, see the xref:configure-deploy-markers#[Configure deploy markers] page.
 
 [#release-status]
-== Release status
+== Deploy status
 
-A release can be in one of the following states:
+A deployment can be in one of the following states:
 
 [.table.table-striped]
 [cols=2*, options="header", stripes=even]
@@ -364,7 +364,7 @@ A release can be in one of the following states:
 |Notes
 
 |RUNNING
-|The release is currently in progress.
+|The deployment is currently in progress.
 
 |FAILED
 |Resources have reached an unhealthy status (pods for the new version of a Kubernetes component).
@@ -373,20 +373,20 @@ A release can be in one of the following states:
 |The Deployment or Rollout has all desired resources available (all pods specified by a Kubernetes Deployment or Argo Rollout).
 
 |CANCELLED
-|The release has been cancelled, either using the `cancel release` option, or by being superseded by another release.
+|The deployment has been cancelled, either using the `cancel deployment` option, or by being superseded by another deployment.
 
 |EXPIRED
-|Release commands failed to be picked up by the release agent within the required time window.
+|Deployment commands failed to be picked up by the release agent within the required time window.
 
 |LOGGED
-|Deployment has been logged using a deploy marker and is available in the CircleCI deployments UI.
+|Deployment has been logged using a deploy marker and is available in the CircleCI deploys UI.
 |===
 
 [#known-limitations]
 == Known limitations
 
-* Restarting the release agent while a deployment is ongoing will cause the release agent to lose track of the deployment status and fail to update the CircleCI services accordingly.
-* **In the CircleCI deployments UI it is currently possible for you to attempt and restore a version that does not exist**. All deployments are presented in the UI, including those outside of the scope of any version history limits you might have set. We do not currently filter out deployments for which there is no longer any data.
+* Restarting the release agent while a deployment is ongoing causes the release agent to lose track of the deployment status and fail to update the CircleCI services accordingly.
+* **In the CircleCI deploys UI it is currently possible for you to attempt to restore a version that does not exist**. All deployments are presented in the UI, including those outside of the scope of any version history limits you might have set. We do not currently filter out deployments for which there is no longer any data.
 +
 Depending on your setup, you will have options for configuring revision history limits: `revisionHistoryLimit` for Kubernetes and Argo Rollouts, and `$HELM_MAX_HISTORY` for Helm.
 +