Parent

OpenShift::DnsService

Abstract DNS update plugin interface

The DNS update plugin communicates with a dynamic DNS service to publish the locations of new applications.

This class defines the abstract interface that will be implemented by plugins which interact with real services.

This class also acts as a factory for the plugin service objects.

@abstract

Public Class Methods

instance() click to toggle source

Factory method for plugin implementation objects @return [DnsService]

an object which implements the DnsService interface
# File lib/openshift/dns_service.rb, line 29
def self.instance
  @oo_dns_provider.new
end
provider=(provider_class) click to toggle source

Set the concrete provider class for the plugin object factory @param [Class <DnsService>] provider_class

The class to instantiate when an instance is requested

@return [Class <DnsService>]

The class which has been set in the factory
# File lib/openshift/dns_service.rb, line 22
def self.provider=(provider_class)
  @oo_dns_provider = provider_class
end

Public Instance Methods

close() click to toggle source

Terminate any open connection to the DNS update service @return [nil]

# File lib/openshift/dns_service.rb, line 83
def close
end
deregister_application(app_name, namespace) click to toggle source

Unpublish an application - remove DNS record

@param [String] app_name

The name of the application to publish

@param [String] namespace

The namespace which contains the application

@return [Object]

The response from the service provider in what ever form
that takes
# File lib/openshift/dns_service.rb, line 59
def deregister_application(app_name, namespace)
end
modify_application(app_name, namespace, public_hostname) click to toggle source

Change the published location of an application - Modify DNS record

@param [String] app_name

The name of the application to publish

@param [String] namespace

The namespace which contains the application

@param [String] public_hostname

The name of the location where the application resides

@return [Object]

The response from the service provider in what ever form
that takes
# File lib/openshift/dns_service.rb, line 73
def modify_application(app_name, namespace, public_hostname)
end
publish() click to toggle source

Send any queued update requests to the DNS update service @return [nil]

# File lib/openshift/dns_service.rb, line 78
def publish
end
register_application(app_name, namespace, public_hostname) click to toggle source

Publish an application - create DNS record

@param [String] app_name

The name of the application to publish

@param [String] namespace

The namespace which contains the application

@param [String] public_hostname

The name of the location where the application resides

@return [Object]

The response from the service provider in what ever form
that takes
# File lib/openshift/dns_service.rb, line 47
def register_application(app_name, namespace, public_hostname)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.