Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

Manage a ServiceBeta

Beta
This is coming — this page describes a feature that's still being rolled out and may not be available to you yet.

Once a service is live, you keep working on it: ship a new pipeline version, review what you served before, and pause or remove the service. Callers keep using the same endpoint while you make these changes. You find and manage all your services in Gateway.

For other service tasks, see Connect to a Published Service, Configure Service Hosting and Cost, and Monitor and Debug a Service.

Prerequisites​

Open a Service​

Every task on this page starts here.

  1. In Haystack Enterprise Platform, click Gateway in the navigation.
  2. Click the name of the service you want to work on.

Publish the First Pipeline to a Service​

If you created a service without a pipeline, its Overview tab shows a Publish your first pipeline section instead of the service details. It offers two ways to publish: Publish from the platform, for a pipeline you built in Pipeline Builder, and Use the CLI or a coding agent, for a Haystack pipeline or agent that lives on your machine. For the steps, see Publish a Pipeline to a Service.

Publish a New Pipeline Version​

When you improve a pipeline, publish the new version to the service so callers get it. The endpoint stays the same, so nothing breaks on their side.

  1. On Overview, in the Pipeline card, click Switch source.
  2. Choose the pipeline or version you want to serve.
  3. Describe what changed. Your note appears in the service deployment history.
  4. Confirm the change.

If your pipeline is in code, click Publish with the CLI instead in the Switch source wizard. You can then copy a prefilled coding agent prompt or CLI commands that publish a new version to this service. That version becomes the one the service serves once it's ready. For details, see Publish a Pipeline to a Service.

To check the pipeline that's running now or the ones you served before, use the Deployment history list on Overview. The version marked Serving is the one handling requests. To inspect the pipeline of any version in the list, see View a Past Revision's Pipeline.

View a Past Revision's Pipeline​

To find out what changed between versions or which version introduced a problem, open a read-only preview of any revision's pipeline, including revisions that are no longer serving. You can inspect its diagram and YAML without affecting what's currently live.

You can start a preview from three places:

  • On Overview, in the Pipeline card, click View pipeline. This opens the currently serving revision.
  • In the Deployment history list, find the revision you want to inspect and click its View pipeline action.
  • For a revision pushed from outside the platform, click its configuration hash.

The preview opens in a modal:

  • To inspect another revision, click it in the timeline down the side. To fetch older revisions, click Load more at the end of the timeline.
  • To see what a revision ran, check its pipeline diagram and YAML.
  • To see where a revision stands, check its status (Current, Previous, Failed, or Publishing) and metadata, such as when it was published. To return to the revision that's serving requests, click Back to current.
  • To build on a revision's pipeline, click Open in Builder. This option isn't available for revisions pushed from outside the platform, or if the underlying pipeline was deleted from the Builder.

If a revision's pipeline definition can't be loaded, the modal shows a message explaining why, for example that the revision failed to publish or that its pipeline definition is missing, along with a retry option where applicable.

Rename a Service or Edit Its Description​

Keep the service easy to recognize as your setup grows.

  1. On Overview, in the About card, click Edit.
  2. Update the name and description.
  3. Save your changes.

Duplicate a Service​

Duplicating a service creates a new service that starts from a copy of the original service's most recently published pipeline version. Use this when you want to reuse an existing service's setup as the starting point for a new environment, for example to create a staging copy of a production service, without affecting the original service.

  1. In the navigation, go to Gateway and open the service you want to duplicate.
  2. Click More Actions and select Duplicate.
  3. In the Duplicate service dialog, review or update the Name field. It's pre-filled with the original service's name followed by "(copy)".
  4. Optional: Update the Description field. It's pre-filled with the original service's description.
  5. Click Duplicate.

We create a new service with the name and description you provided, and publish a copy of the original service's pipeline version to it. The new pipeline version's deployment history includes a note that it was duplicated from the original service.

If the pipeline version can't be published automatically, the new service is still created. You can publish a pipeline version to it manually. For details, see Publish a Pipeline to a Service.

Deactivate a Service to Save Resources​

Stop a service from handling requests when you don't need it. Deactivating stops active-hour metering. The service record and the published pipeline version stay in place, so you can bring it back anytime.

Service statuses
  • Active: The service is deployed and handling requests.
  • Standby: The service is idle after the idle timeout in hosting settings. It wakes automatically on a request, or you can wake it manually.
  • Inactive: You deactivated the service. It does not handle requests.
  1. On Overview, in the Pipeline card, click More Actions.
  2. Choose Deactivate service and confirm. For a production service, type the service name to confirm.

The status changes to Inactive.

Wake or Activate a Service​

A service goes on standby after it reaches the idle timeout configured in the hosting settings. For details, see Configure Service Hosting and Cost.

  1. On Overview, in the Pipeline card, click More Actions.
  2. Choose Wake service if the service is on standby, or Activate service if it is inactive.

Delete a Service​

Remove a service you don't plan to use again. This removes the endpoint

but keeps the underlying pipeline. Deactivate the service first.

warning

Deleting a service cannot be undone.

  1. On Overview, in the Pipeline card, click More Actions.
  2. If the service is active, click Deactivate service and confirm.
  3. Click More Actions again, choose Delete service, and confirm. For a production service, type the service name to confirm.

The service is removed and you return to Gateway.

What To Do Next​