Click or drag to resize

KubeService Constructor

Constructor.

Namespace:  Neon.Kube.Service
Assembly:  Neon.Kube.Service (in Neon.Kube.Service.dll) Version: 2.1.0
Syntax
public KubeService(
	ServiceMap serviceMap,
	string name,
	string branch = null,
	string commit = null,
	bool isDirty = false,
	string statusFilePath = null
)

Parameters

serviceMap
Type: Neon.ServiceServiceMap
The service map describing this service and potentially other services.
name
Type: SystemString
The name of this service within ServiceMap.
branch (Optional)
Type: SystemString
Optionally specifies the build branch.
commit (Optional)
Type: SystemString
Optionally specifies the branch commit.
isDirty (Optional)
Type: SystemBoolean
Optionally specifies whether there are uncommit changes to the branch.
statusFilePath (Optional)
Type: SystemString
Optionally specifies the path where the service will update its status (for external health probes). See the class documentation for more information Neon.Kube.Service.
Exceptions
ExceptionCondition
KeyNotFoundException Thrown if there is no service description for name within the ServiceMap.
Remarks

For those of you using Git for source control, you'll want to pass the information about the branch and latest commit you're you service was built from here. We use the GitInfo nuget package to obtain this information from the local Git repository.

Alternatively, you could try to map properties from your source control environment to these parameters, pass your version string as branch, or simply ignore these parameters.

See Also