Deploy on Cloud

​

Prerequisites

• Applications are deployed from GitHub repositories. Configure and upload an application to a GitHub repository.
• Verify that the LangGraph API runs locally. If the API does not run successfully (i.e., langgraph dev), deploying to LangSmith will fail as well.

​

Create new deployment

1. In the Create New Deployment panel, fill out the required fields. For Deployment details:
   1. Select Import from GitHub and follow the GitHub OAuth workflow to install and authorize LangChain’s hosted-langserve GitHub app to access the selected repositories. After installation is complete, return to the Create New Deployment panel and select the GitHub repository to deploy from the dropdown menu.
      The GitHub user installing LangChain’s hosted-langserve GitHub app must be an owner of the organization or account. This authorization only needs to be completed once per LangSmith workspace—subsequent deployments can be created by any user with deployment permissions.
   2. Specify a name for the deployment.
   3. Specify the desired Git Branch. A deployment is linked to a branch. When a new revision is created, code for the linked branch will be deployed. The branch can be updated later in the Deployment Settings.
   4. Specify the full path to the LangGraph API config file including the file name. For example, if the file langgraph.json is in the root of the repository, specify langgraph.json.
   5. Use the checkbox to Automatically update deployment on push to branch. If checked, the deployment will automatically be updated when changes are pushed to the specified Git Branch. You can enable or disable this setting on the Deployment Settings in the UI. For Deployment Type:
      • Development deployments are meant for non-production use cases and are provisioned with minimal resources.
      • Production deployments can serve up to 500 requests/second and are provisioned with highly available storage with automatic backups.
   6. Determine if the deployment should be Shareable through Studio.
      1. If unchecked, the deployment will only be accessible with a valid LangSmith API key for the workspace.
      2. If checked, the deployment will be accessible through Studio to any LangSmith user. A direct URL to Studio for the deployment will be provided to share with other LangSmith users.
   7. Specify Environment Variables and secrets. To configure additional variables for the deployment, refer to the Environment Variables reference.
      1. Sensitive values such as API keys (e.g., OPENAI_API_KEY) should be specified as secrets.
      2. Additional non-secret environment variables can be specified as well.
   8. A new LangSmith tracing project is automatically created with the same name as the deployment.
2. In the top-right corner, select Submit. After a few seconds, the Deployment view appears and the new deployment will be queued for provisioning.

​

Create new revision

1. In the Deployment view, in the top-right corner, select + New Revision.
2. In the New Revision modal, fill out the required fields.
   1. Specify the full path to the API config file including the file name. For example, if the file langgraph.json is in the root of the repository, specify langgraph.json.
   2. Determine if the deployment should be Shareable through Studio.
      • If unchecked, the deployment will only be accessible with a valid LangSmith API key for the workspace.
      • If checked, the deployment will be accessible through Studio to any LangSmith user. A direct URL to Studio for the deployment will be provided to share with other LangSmith users.
   3. Specify Environment Variables and secrets. Existing secrets and environment variables are prepopulated. To configure additional variables for the revision, refer to the Environment Variables reference.
      1. Add new secrets or environment variables.
      2. Remove existing secrets or environment variables.
      3. Update the value of existing secrets or environment variables.
3. Select Submit`. After a few seconds, the New Revision modal will close and the new revision will be queued for deployment.

​

View build and server logs

1. Select the desired revision from the Revisions table. A panel slides open from the right-hand side and the Build tab is selected by default, which displays build logs for the revision.
2. In the panel, select the Server tab to view server logs for the revision. Server logs are only available after a revision has been deployed.
3. Within the Server tab, adjust the date/time range picker as needed. By default, the date/time range picker is set to the Last 7 days.

​

View deployment metrics

1. In the left-hand navigation panel, select Deployments.
2. Select an existing deployment to monitor.
3. Select the Monitoring tab to view the deployment metrics. Refer to a list of all available metrics.
4. Within the Monitoring tab, use the date/time range picker as needed. By default, the date/time range picker is set to the Last 15 minutes.

​

Interrupt revision

1. Select the menu icon (three dots) on the right-hand side of the row for the desired revision from the Revisions table.
2. Select Interrupt from the menu.
3. A modal will appear. Review the confirmation message. Select Interrupt revision.

​

Delete deployment

1. In the left-hand navigation panel, select Deployments, which contains a list of existing deployments.
2. Select the menu icon (three dots) on the right-hand side of the row for the desired deployment and select Delete.
3. A Confirmation modal will appear. Select Delete.

​

Deployment settings

1. In the top-right corner, select the gear icon (Deployment Settings).
2. Update the Git Branch to the desired branch.
3. Check/uncheck checkbox to Automatically update deployment on push to branch.
   1. Branch creation/deletion and tag creation/deletion events will not trigger an update. Only pushes to an existing branch will trigger an update.
   2. Pushes in quick succession to a branch will queue subsequent updates. Once a build completes, the most recent commit will begin building and the other queued builds will be skipped.

​

Add or remove GitHub repositories

1. From the GitHub profile, navigate to Settings > Applications > hosted-langserve > click Configure.
2. Under Repository access, select All repositories or Only select repositories. If Only select repositories is selected, new repositories must be explicitly added.
3. Click Save.
4. When creating a new deployment, the list of GitHub repositories in the dropdown menu will be updated to reflect the repository access changes.

​

Allowlist IP addresses