Skip to content

SCRIPT_USAGE.md

Latest commit

 

History

History
78 lines (50 loc) · 2.58 KB

SCRIPT_USAGE.md

File metadata and controls

78 lines (50 loc) · 2.58 KB

Script Usage

How to use the various scripts in this repository.

Assumes you've followed Getting Started on README.

knoxEnvSetup.sh

Sets up (on a Linux machine) and environment which allows the contribution to Apache Knox, my fork of Knox, and this repository.

Sets up

  • the PATH variable to allow access to scripts in this repository

  • git clone of Apache Knox (with official Apache Knox as upstream and my fork as origin)

  • Adds environment variable for an HDP IP/name for ease-of-use.

  • See knoxEnvSetup.sh

build.sh

Small wrapper script around Maven builds.

It allows a simple bash options style of build, with the aim of reducing the amount of typing needed for the most frequently used option.

Don't use on it's own, use with knoxBuild.sh

  • See build.sh
  • build.sh -h for up-to-date help information

knoxBuild.sh

Calls the build.sh script with the appropriate options to allow a successful build of Knox.

knoxStop.sh

For execution on a Hortonworks Data Platform v2.4 Sandbox.

Stops Apache Knox and it's LDAP service.

knoxUpgrade.sh

Upgrades Apache Knox to a new version on a Hortoworks Data Platform v2.4 sandbox.

Use knoxStop.sh and knoxUpgrade.sh in conjuntion with the Deployment guide.

knoxCheck.sh

Checks that Knox is responsive on a Hortonworks Data Platform v2.4 sandbox.

Expected to be used after knoxUpgrade.sh.

Merge Upstream to Origin

Merges the upstream (official Apache Knox repository) into the origin (my fork).

Reset Origin To Upstream

Resets the status of origin so that it is an exact replica of upstream.

The main use of this is after a patch is applied to upstream we can set origin to have the same commits as upstream (otherwise it always appears to be ahead).

Solr Querying

Wrapper round querying to Solr. Builds up the URL for curl, based on a small number of mandatory options.

  • See solrQuery.sh
  • Mandatory options are
    • -c (solr collection to query)
    • -q (solr query type, e.g. select)
    • -a (solr query arguments e.g. "q=*.*")
  • Run solrQuery.sh -h for up-to-date options.

Example solrQuery.sh -q select -a "q=*.*" -c "KnoxIntegrationConfig"