Class ServiceDescription
Describes a remote service.
Namespace: Neon.Service
Assembly: Neon.Common.dll
Syntax
public class ServiceDescriptionConstructors
ServiceDescription()
Constructor.
Declaration
public ServiceDescription()Properties
Address
When set, this overrides Name, Namespace, and
Domain when generating the Hostname result.
This is typically set for public service endpoints for public deployments
or when emulating a cluster on a local machine for testing purposes.
This defaults to null.
Declaration
public string Address { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Domain
The cluster's configured domain (aka zone). This defaults to "cluster.local".
Declaration
public string Domain { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Endpoints
The service's network endpoints.
Declaration
public ServiceEndpoints Endpoints { get; set; }Property Value
| Type | Description |
|---|---|
| ServiceEndpoints |
FullHostname
Returns the hostname to be used to communcate with this service. When deployed
to a Kubernetes cluster, this will be formed from Name and Namespace,
including the Domain. When testing and Address is not null,
then this will simply be the address converted to a string.
note
Use Hostname if you need the fully qualified hostname that includes the cluster domain.
Declaration
public string FullHostname { get; }Property Value
| Type | Description |
|---|---|
| string |
Hostname
Returns the hostname to be used to communcate with this service. When deployed
to a Kubernetes cluster, this will be formed from Name and Namespace,
omitting the Domain. When testing and Address is not null,
then this will simply be the address converted to a string.
note
Use FullHostname if you need the fully qualified hostname that includes the cluster domain.
Declaration
public string Hostname { get; }Property Value
| Type | Description |
|---|---|
| string |
MetricsPort
The service's Prometheus metrics exporter port.
Declaration
public int MetricsPort { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Name
The service name as deployed to Kubernetes.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Namespace
The Kubernetes namespace where the service is deployed. This defaults to "default".
Declaration
public string Namespace { get; set; }Property Value
| Type | Description |
|---|---|
| string |
TestBinaryConfigFiles
Used to hold binary configuration files that will be set when deploying the service in a test
via NeonServiceFixture.
Declaration
public Dictionary<string, byte[]> TestBinaryConfigFiles { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, byte[]> |
TestEnvironmentVariables
Used to hold environment variables that will be set when deploying the service in a test
via NeonServiceFixture.
Declaration
public Dictionary<string, string> TestEnvironmentVariables { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, string> |
TestTextConfigFiles
Used to hold text configuration files that will be set when deploying the service in a test
via NeonServiceFixture.
Declaration
public Dictionary<string, string> TestTextConfigFiles { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, string> |