Class: Arkaan::Monitoring::Service

Inherits:

Object

• Object
• Arkaan::Monitoring::Service

Includes:

Concerns::Activable, Concerns::Diagnosticable, Concerns::Premiumable, Mongoid::Document, Mongoid::Timestamps

Defined in:

lib/arkaan/monitoring/service.rb

Overview

A service is the representation of one of the applications composing the API.

Author:

• Vincent Courtois <courtois.vincent@outlook.com>

Instance Attribute Summary

• #creator ⇒ Arkaan::Account

  The creator of this service.

• #key ⇒ String

  The name of the service, used as a namespace on the Kubernetes side.

• #path ⇒ String

  The path the service will be mapped on in the API.

• #routes ⇒ Array<Arkaan::Monitoring::Route>

  The routes associated to this service, accessible from the gateway.

Instance Attribute Details

#creator ⇒ Arkaan::Account

Returns the creator of this service.

Returns:

• (Arkaan::Account) —

  the creator of this service.

# File 'lib/arkaan/monitoring/service.rb', line 23

belongs_to :creator, class_name: 'Arkaan::Account', optional: true, inverse_of: :services

#key ⇒ String

Returns the name of the service, used as a namespace on the Kubernetes side.

Returns:

• (String) —

  the name of the service, used as a namespace on the Kubernetes side.

# File 'lib/arkaan/monitoring/service.rb', line 16

field :key, type: String

#path ⇒ String

Returns the path the service will be mapped on in the API. This will be used in the Ingress.

Returns:

• (String) —

  the path the service will be mapped on in the API. This will be used in the Ingress.

# File 'lib/arkaan/monitoring/service.rb', line 19

field :path, type: String, default: '/'

#routes ⇒ Array<Arkaan::Monitoring::Route>

Returns the routes associated to this service, accessible from the gateway.

Returns:

• (Array<Arkaan::Monitoring::Route>) —

  the routes associated to this service, accessible from the gateway.

# File 'lib/arkaan/monitoring/service.rb', line 26

has_many :routes, class_name: 'Arkaan::Monitoring::Route', inverse_of: :service