Skip to content

Latest commit

 

History

History
179 lines (113 loc) · 10.3 KB

COMPLIANCE_PROCESS.md

File metadata and controls

179 lines (113 loc) · 10.3 KB
Raw

ODPi Compliance Process

Table of Contents

Purpose of this document

This document outlines the process needed for a product to fulfill the requirements for compliance with an ODPi Specification Release. ODPi Compliance is intended to be used by organizations to ensure their compliance with the big data industry standards governed by ODPi.

Definitions

Platform - A product or service offering that consists of Apache Hadoop™, and optionally includes additional open source and/or commercial components that work with Apache Hadoop™.

Platform Vendor- An organization, either a commercial vendor or an open source project, that either produces a packaged version of the Platform or supports a service offering around the platform aimed at end-user consumption.

Application - A product that is intended to interoperate with a Platform.

Software Vendor - An organization, either a commercial vendor or an open source project, that has a product that works with a Platform.

End Users - Users of a Platform and/or Application.

ODPi Runtime Specification - Specification developed by the ODPi community that describes expected runtime behavior of a platform, located at https://github.com/odpi/specs/blob/master/ODPi-Runtime.md.

ODPi Runtime Test Harness - Test harness developed by the Apache Bigtop community that verifies expected runtime behavior of an Apache Hadoop-based platform, available for download at https://www.apache.org/dist/bigtop/1.2.0/bigtop-1.2.0-testsuite.zip.

ODPi Operations Specification - Specification developed by the ODPi community that describes expected operational behavior of an Apache Hadoop-based platform, located at https://github.com/odpi/specs/blob/master/ODPi-Operations.md.

ODPi Specification Release - A published version of the ODPi Runtime or ODPi Operations Specifications with an associated version number.

ODPi Compliance Process - The process defined by the ODPi TSC to validate and verify compliance with an ODPi Specification Release for an Platform Vendor or a Software Vendor.

ODPi Compliance Program overview

The following matrix indicates the available programs, along with specification(s) and vendor classifications applicable for each.

Program Description Vendor type applicable for
ODPi Runtime Compliant Confirms that a specific version of an Platform has been successfully tested against the ODPi Runtime Specification test harness. Platform Vendor
ODPi Operations Compliant Confirms that a specific version of Platform is following ODPi Operations Specification guidelines. It also confirms that when a platform gets deployed using a bundled Hadoop Management Tool the result is ODPi Runtime compliant. Platform Vendor
ODPi Interoperable Confirms that a specific version of an ISV Application leverages the components as outlined in a specific version of the ODPi Specification Release. Software Vendor

Compliance Process

There are specific steps required for each compliance program for the vendor to confirm compliance.

ODPi Runtime Compliant

  1. Review the most recently published ODPi Runtime Spec.

  2. Download the latest Apache Bigtop acceptance test suite.

  3. Unzip the test package on the primary machine on your Hadoop cluster you wish to test.

  4. Install links on the primary machine on your Hadoop cluster you wish to test ( Either grab source from http://links.twibright.com/download.php or use the command below to install )

sudo yum install links

  1. Run with user that has yarn admin privilages.

  2. Make sure that user has passwordless sudo access and has a home directory e.g. /user/yarn in HDFS.

  3. Use ./run_itest.sh -h or ./run_itest.sh --help to display arguments and defaults.

Usage : ./run_itest.sh [-options]

   -j, --hivejdbc             hive jdbc url - default: e.g. jdbc:hive2://localhost:10000
   -m, --hivemeta             hive metastore url - default: thrift://localhost:9083
   -l, --hivelocation         location of hdfs for hive to write to - default: /tmp/
   -u, --hiveuser             hive user - default: hive
   -p, --hivepassword         hive user password - default: hive
   -t, --hivethrift           optional: true/false to test thrift, defaults to true
   -c, --hivecatalog          optional: true/false to test HCatalog, default to true
   -C, --hiveconf             hive conf dir - default: /etc/hive/conf
   -F, --hadoopconf           hadoop user - default: /etc/hadoop/conf
   -i, --info                 optional: info/debug
   -h, --help                 display this help and exit
  1. Run the tests, with needed arguments and optionally outputting the results to a text file.
./run_itest.sh --info info > testresults.log 2>&1

  1. If the test pass, issue a pull request with the text output in a file using the naming convention: /$HADOOP_VERSION-$OS-$ARCH-$SPECVERSION.txt to the https://github.com/odpi/self-certification-reports repository.

  2. A member of the ODPi TSC will review and merge in.

  3. A member of the ODPi marketing team will follow up with trademark assets and guidelines for advertising ODPi compliance.

ODPi Operations Compliant

  1. Review the most recently published ODPi Operations Spec.

  2. Deploy a platform using a bundled Hadoop Management Tool.

  3. Verify that the resulting platform confirms to the ODPi Runtime specification as per previous section.

  4. Capture environment information using script available under http://XXXX

  5. Issue a pull request with the text output of steps #3 and #4 in a file using the naming convention: /$HADOOP_VERSION-$OS-$ARCH-$SPECVERSION.txt to the https://github.com/odpi/self-certification-reports repository.

  6. A member of the ODPi TSC will review and merge in.

  7. A member of the ODPi marketing team will follow up with trademark assets and guidelines for advertising ODPi compliance.

ODPi Interoperable

  1. Review the most recently published ODPi Runtime Spec and ODPi Operations Spec.

  2. Install (or gain access to) a Platform that is compliant with the latest version of the ODPi Specification Release. While it is not strictly required, we highly recommend that you also consider installing an ODPi reference implementation platform in addition to a vendor’s one. Running the tests on ODPi reference implementation guarantees that only ODPi core component get deployed and also helps with having an access to a 100% open platform, unencumbered with EULAs.

  3. Complete the questionnaire outlined below ( all info to be shared publically )

    1. Product name / version

    2. Primary contact for questions on this questionnaire

    3. Which technologies governed by the ODPi Runtime Specification does this application interoperate with?

    4. Which ODPi-compliant distributions and versions did you test with?

    5. Did you deploy, configure and operated your application using ODPi Operations compatible Hadoop Management Tool?

    6. If your application supports a deployment and configuration model other than using and ODPi Operations compatible Hadoop Management Tool please describe it here.

    7. Please describe your testing procedure you use to demonstrate compatibility and what passing results will be.

    8. What modifications did you make to your software or underlying configurations for each distribution in order for them to pass?

    9. Did you test with any ODPi-compliant distributions that did not pass your interoperability tests?

    10. Did you notice any different behavior in your software or the underlying distributions when you ran your tests, whether or not you deemed the tests as passing?

    11. Which ODPi-compliant distributions and versions do you provide support for in the deployment of your software?

  4. Issue a pull request with the text output in a file using the naming convention: /$PRODUCT_NAME_AND_VERSION-$SPECVERSION.txt to the https://github.com/odpi/self-certification-reports repository.

  5. A member of the ODPi TSC will review and merge in.

  6. A member of the ODPi marketing team will follow up with trademark assets and guidelines for advertising ODPi compliance.

Ongoing compliance

ODPi compliance is not a one time event, but an ongoing commitment between Platform Vendors, ISVs, and the ODPi to ensure that the best practices outlined by the ODPi Specification Releases are adhered to for the benefit of End Users. As such, ODPi has the following requirements and recommendations for ongoing compliance.

  • Platform Vendors and Software Vendors should look to include the ODPi Compliance Process as a part of their integration testing and release process.

  • Platform Vendors and Software Vendors are required to submit a new report for each ODPi Specification Release subsequent to the first ODPi Specification Release they complete the ODPi Compliance Process for.

  • ODPi will publish the results of ODPi compliance testing to the ODPi website.