Skip to content

Latest commit

 

History

History
86 lines (52 loc) · 5.08 KB

Container-README.md

File metadata and controls

86 lines (52 loc) · 5.08 KB
Raw

ServicePulse

This document describes basic usage and information related to the ServicePulse image. The complete documentation of ServicePulse the application can be found on the Particular Software documentation site.

Usage

The following is the most basic way to create a ServicePulse container using Docker:

docker run -p 9090:9090 particular/servicepulse:latest

Environment Variables

  • SERVICECONTROL_URL: Default: http://localhost:33333. The url to your ServiceControl instance
  • MONITORING_URL: Default: http://localhost:33633. The url to your Monitoring instance
  • DEFAULT_ROUTE: Default: /dashboard. The default page that should be displayed when visiting the site
  • SHOW_PENDING_RETRY Default: false. Set to true to show details of pending retries
  • ENABLE_REVERSE_PROXY Default: true. Set to false to disable the proxy that forwards requests to the ServiceControl and Monitoring instances

It may be desireable to run the ServiceControl services in an isolated network. When doing so, ServicePulse must be configured to connect to those services using environment variables:

docker run -p 9090:9090 -e SERVICECONTROL_URL="http://servicecontrol:33333" -e MONITORING_URL="http://servicecontrol-monitoring:33633" particular/servicepulse:latest

Or as part of a Docker Compose services specification:

services:
    servicepulse:
        ports:
            - 9090:9090
        environment:
            - SERVICECONTROL_URL=http://servicecontrol:33333
            - MONITORING_URL=http://servicecontrol-monitoring:33633
        image: particular/servicepulse:latest

Image tagging

latest tag

This tag is primarily for developers wanting to use the latest version, e.g. docker-compose up -d --build --force-recreate --renew-anon-volumes.

If a release targets the current latest major or is a new major after the previous latest, then the :latest tag applied to the image pushed to Docker Hub.

If the release is a patch release to a previous major, then the :latest tag will not be added to the image pushed to Docker Hub.

The :latest tag is never added to images pushed to the GitHub Container Registry.

Version tags

We use SemVer for versioning. Release images pushed to Docker Hub will be tagged with the release version. Staged images pushed to the GitHub Container Registry will not have a version tag.

Pull request tag

Pre-release image versions generated from GitHub pull requests will only be available in the GitHub Container Registry and are tagged using the pull request number using the following convention: pr-1234. The pull request tag is only added to images pushed to the GitHub Container Registry and are not added to images pushed to Docker Hub.

Major version tag

The latest release within a major version will be tagged with the major version number only on images pushed to Docker Hub. This allows users to target a specific major version to help avoid the risk of incurring breaking changes between major versions. Useful for auto-upgrading containers in a production, for instance:

If particular/servicepulse:1.30.1 is the latest release in the version 1 major release, the image will also be tagged particular/servicepulse:1.

The major version tag is never added to images pushed to the GitHub Container Registry.

Minor version tag

The latest release within a minor version will be tagged with {major}.{minor} on images pushed to Docker Hub. This allows users to target the latest patch within a specific minor version.

Image architecture

This image is a multi-arch image based on the mcr.microsoft.com/dotnet/aspnet:8.0-noble-chiseled-composite base image supporting linux/arm64 and linux/amd64.

Contributing

Please read our documentation for details on how to contribute to Particular Software projects.

Authors

This software, including this container image, is built and maintained by the team at Particular Software. See also the list of contributors who participated in this project.

License

This project is licensed under the Reciprocal Public License 1.5 (RPL1.5) and commercial licenses are available - see the LICENSE.md file for details.