Template:DPE Kubernetes Service/doc

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for DPE Kubernetes Service

Metadata about a Data Platform service hosted on Kubernetes

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
serviceName	serviceName name	The service name	String	required
kubernetesCluster	kubernetesCluster	Name of the kubernetes cluster the service is deployed to	String	required
kubernetesNamespace	kubernetesNamespace namespace	Kubernetes namespace	String	required
chartUrl	chartUrl chart	The URL to the service chart	URL	suggested
helmfilesUrl	helmfilesUrl helmfiles	URL of the service helmfiles	URL	required
dockerImageUrl	dockerImageUrl dockerImage	The URL of the docker image definition	URL	suggested
internalDNS	internalDNS	Internal DNS record pointing to the service	String	suggested
publicURL	publicURL	Public URL linking to the service (if any)	URL	optional
logsUrl	logsUrl logs	Logs dashboard URL	URL	suggested
metricsDashboardUrl	metricsDashboardUrl metrics	URL of the service metrics dashboard	URL	suggested
monitorsUrl	monitorsUrl monitors	URL of the service monitors	URL	suggested
applicationDocumentationUrl	applicationDocumentationUrl documentation	Documentation of the deployed application	URL	suggested
paging	paging	Whether the app is paging Default false	Boolean	required
owner	owner	Owner (team)	String	required
phabricatorTicketUrl	phabricatorTicketUrl	Deployment phabricator ticket	URL	suggested