Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

This is an attempt to sketch out the admin and developer visible changes that could be used to support version specific contributors.  This type of mechanism is required for two reasons:

  1. Knox should prevent attempts to use REST APIs that do not exist in older versions of services.
  2. Not all services maintain strict backward compatibility between versions and as such required different Knox behavior per version.

Below is a sample of how the ServiceDeploymentContributor contract could be enhanced to declare support for particular versions.

Code Block
languagejava
titleServiceDeploymentContributorVersionedServiceDeploymentContributor
linenumberstrue
package org.apache.hadoop.gateway.deploy;
import org.apache.hadoop.gateway.topology.Service;
public interface ServiceDeploymentContributor {
  // TheAn roleextension ofto thisbase serviceinterface deploymentfor contributor.backward compatibility e.g. WEBHDFS
  String getRole();

  // The name of this service deployment contributor.  Not used yet.
  String getName();
 with existing contributors.
// Service located and loaded via the base interface.
public interface VersionedServiceDeploymentContributor extends ServiceDeploymentContributor {
  // The listversions supported ofby versionsthis supportedcontributor.
  Each element formatted// Formatted according to the Maven Enforcer plugin syntax.
  String[] getVersions();

  // Called after provider initializeContribution methods and in arbitrary order relative to other service contributors.
  void initializeContribution( DeploymentContext context );

  // Called per service based on the service's role.// http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html
  // ReturnsReturning anull listindicates ofthat resourcesall itversions addedare tosupported theand descriptor.
is equivalent void contributeService( DeploymentContext context, Service service ) throws Exception;
to "[0,)"
  // Called after all contributors and before provider finalizeContribution methods.
  void finalizeContribution( DeploymentContext context String getVersions();
}

Below is a sample of how version could be added to the topology file.

Code Block
languagexml
titleToplogy File
linenumberstrue
<topology>
    <gateway>
    ...
    </gateway>
    ....
    <service>
        <role>HIVE</role>
        <version>0.13.0</version>
        <url>http://localhost:10001/cliservice</url>
        <version>0.13.0</version>
    </service>
</topology>

 

Contributor Selection

  1. In general the contributor declaring the latest explicit version support that includes the required version is selected.
  2. In the case of a tie selection will continue with the next latest explicit version support
  3. This will continue until a single contributor is selected.
  4. If this is not possible an arbitrary selection will be made from the remaining candidates.

Open Questions