Migrate to Service
Migrate your deployed pipelines to services in Gateway. Services give your callers a stable endpoint, so you can publish new pipeline versions without changing it.
About This Task
Until now, your pipelines were deployed directly to the platform. Each deployment created a new endpoint, which could change as you modified the pipeline.
There are two ways to migrate to services:
- Automatic migration: This is the easiest way to migrate to services. It automatically creates a service with the same hosting settings as your pipeline and publishes your pipeline there. All you need to do is update the endpoint URL in the callers. This is a one-time action.
- Manual migration: This involves creating a service manually and publishing your pipeline to it.
After you create a service, you can update its settings, including hosting, as needed.
To learn more, see Gateway.
Your data is safe during the migration. A pipeline can be deployed in Haystack Platform and published to a service at the same time. This means all the apps calling the pipeline continue to work without any downtime.
You must update your callers to use the new service endpoint. Until you do that, they continue to call the old pipeline endpoint.
Prerequisites
- You must have a pipeline deployed to the platform.
- You must have read and write permissions to services to update services. For details, see User Roles and Permissions.
Migrate Automatically
- In Haystack Enterprise Platform, click Pipelines in the navigation.
- Find a deployed pipeline you want to migrate to a service and click Migrate to service next to it.

- Update the service name, description, and tags if needed. By default, the service name is the pipeline name with the
-servicesuffix. You can add up to three tags to help you group and filter your services later. The service inherits the pipeline's hosting settings. You can update them after the service is created. - Click Create Service. The service is starting. Once it's active, you'll see your pipeline and deployment history there.
Migrate Manually
Follow the steps in Publish a Pipeline to a Service to publish your pipeline to a service.
What To Do Next
Update your callers to use the new service endpoint:
- Open the service to which you published your pipeline and switch to the Connect tab.
- Try calling the service with a sample query. If it works, you're ready to update your callers. If it fails, check that the service is active and that you copied the endpoint from the Connect tab.
- Copy the endpoint URL and update it in your callers.
- If your callers also use sessions, feedback, search metadata, or health checks, see Move Sessions, Feedback, Metadata, and Health Checks to a Service with the REST API.
Related Information
Was this page helpful?