Skip to content

Commit

Permalink
OOZIE-3725 Drop support for the webui
Browse files Browse the repository at this point in the history
  • Loading branch information
dionusos committed Jan 16, 2025
1 parent 4197223 commit 670689b
Show file tree
Hide file tree
Showing 62 changed files with 25 additions and 9,105 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ distro/downloads
SecurityAuth.audit
build
webapp/overlays
# macos
.DS_Store
42 changes: 1 addition & 41 deletions distro/src/main/bin/addtowar.sh
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ function printUsage() {
echo " -outputwar OUTPUT_OOZIE_WAR"
echo " [-hadoop HADOOP_VERSION HADOOP_PATH]"
echo " [-hadoopJarsSNAPSHOT] (if Hadoop jars version on system is SNAPSHOT)"
echo " [-extjs EXTJS_PATH] (expanded or ZIP)"
echo " [-jars JARS_PATH] (multiple JAR path separated by ':')"
echo " [-secureWeb WEB_XML_PATH] (path to secure web.xml)"
echo
Expand All @@ -129,12 +128,10 @@ if [ $# -eq 0 ]; then
fi

addHadoop=""
addExtjs=""
addJars=""
hadoopVersion=""
hadoopHome=""
hadoopJarsSuffix=""
extjsHome=""
jarsPath=""
inputWar=""
outputWar=""
Expand Down Expand Up @@ -166,17 +163,6 @@ do
elif [ "$1" = "-hadoopJarsSNAPSHOT" ]; then
shift
hadoopJarsSuffix="SNAPSHOT"
elif [ "$1" = "-extjs" ]; then
shift
if [ $# -eq 0 ]; then
echo
echo "Missing option value, ExtJS path"
echo
printUsage
exit -1
fi
extjsHome=$1
addExtjs=true
elif [ "$1" = "-jars" ]; then
shift
if [ $# -eq 0 ]; then
Expand Down Expand Up @@ -223,7 +209,7 @@ do
shift
done

if [ "${addHadoop}${addExtjs}${addJars}" == "" ]; then
if [ "${addHadoop}${addJars}" == "" ]; then
echo
echo "Nothing to do"
echo
Expand All @@ -242,10 +228,6 @@ if [ "${addHadoop}" = "true" ]; then
checkFileExists ${hadoopHome}
getHadoopJars ${hadoopVersion}
fi

if [ "${addExtjs}" = "true" ]; then
checkFileExists ${extjsHome}
fi

if [ "${addJars}" = "true" ]; then
for jarPath in ${jarsPath//:/$'\n'}
Expand Down Expand Up @@ -291,28 +273,6 @@ if [ "${addHadoop}" = "true" ]; then
done
fi

if [ "${addExtjs}" = "true" ]; then
if [ ! "${components}" = "" ];then
components="${components}, "
fi
components="${components}ExtJS library"
if [ -e ${tmpWarDir}/ext-2.2 ]; then
echo
echo "Specified Oozie WAR '${inputWar}' already contains ExtJS library files"
echo
cleanUp
exit -1
fi
#If the extjs path given is a ZIP, expand it and use it from there
if [ -f ${extjsHome} ]; then
unzip ${extjsHome} -d ${tmpDir} > /dev/null
extjsHome=${tmpDir}/ext-2.2
fi
#Inject the library in oozie war
cp -r ${extjsHome} ${tmpWarDir}/ext-2.2
checkExec "copying ExtJS files into staging"
fi

if [ "${addJars}" = "true" ]; then
if [ ! "${components}" = "" ];then
components="${components}, "
Expand Down
28 changes: 1 addition & 27 deletions distro/src/main/bin/oozie-setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ function printUsage() {
echo " created by export"
echo " (without options prints this usage information)"
echo
echo " EXTJS can be downloaded from http://www.extjs.com/learn/Ext_Version_Archives"
echo
}

#Creating temporary directory
Expand Down Expand Up @@ -117,10 +115,8 @@ JETTY_LIB_DIR=${JETTY_WEBAPP_DIR}/WEB-INF/lib/

source ${BASEDIR}/bin/oozie-sys.sh -silent

addExtjs=""
addHadoopJars=""
additionalDir=""
extjsHome=""
jarsPath=""
prepareWar=""

Expand Down Expand Up @@ -181,15 +177,7 @@ log_ready_to_start() {
echo
}

check_extjs() {
if [ "${addExtjs}" = "true" ]; then
checkFileExists ${extjsHome}
else
echo "INFO: Oozie webconsole disabled, ExtJS library not specified"
fi
}

# Check if it is necessary to add extension JARs and ExtJS
# Check if it is necessary to add extension JARs
check_adding_extensions() {
libext=${OOZIE_HOME}/libext
if [ "${additionalDir}" != "" ]; then
Expand All @@ -204,10 +192,6 @@ check_adding_extensions() {
addJars="true"
done
fi
if [ -f "${libext}/ext-2.2.zip" ]; then
extjsHome=${libext}/ext-2.2.zip
addExtjs=true
fi
fi
}

Expand All @@ -219,16 +203,6 @@ cleanup_and_exit() {

prepare_jetty() {
check_adding_extensions
check_extjs

if [ "${addExtjs}" = "true" -a ! -e ${JETTY_WEBAPP_DIR}/ext-2.2 ]; then
unzip ${extjsHome} -d ${JETTY_WEBAPP_DIR}
checkExec "Extracting ExtJS to ${JETTY_WEBAPP_DIR}/"
elif [ "${addExtjs}" = "true" -a -e ${JETTY_WEBAPP_DIR}/ext-2.2 ]; then
# TODO
echo "${JETTY_WEBAPP_DIR}/ext-2.2 already exists"
cleanup_and_exit
fi

if [ "${addJars}" = "true" ]; then
for jarPath in ${jarsPath//:/$'\n'}
Expand Down
26 changes: 6 additions & 20 deletions docs/src/site/markdown/AG_Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,12 @@ Usage : oozie-setup.sh <Command and OPTIONS>
If a directory `libext/` is present in Oozie installation directory, the `oozie-setup.sh` script will
include all JARs in Jetty's `webapp/WEB_INF/lib/` directory.

If the ExtJS ZIP file is present in the `libext/` directory, it will be added to the Jetty's `webapp/` directory as well.
The ExtJS library file name be `ext-2.2.zip`.

### Setting Up Oozie with an Alternate Tomcat

Use the `addtowar.sh` script to prepare the Oozie server only if Oozie will run with a different
servlet container than the embedded Jetty provided with the distribution.

The `addtowar.sh` script adds Hadoop JARs, JDBC JARs and the ExtJS library to the Oozie WAR file.
The `addtowar.sh` script adds Hadoop JARs, JDBC JARs to the Oozie WAR file.

The `addtowar.sh` script options are:

Expand All @@ -100,19 +97,18 @@ The `addtowar.sh` script options are:
Options: -inputwar INPUT_OOZIE_WAR
-outputwar OUTPUT_OOZIE_WAR
[-hadoop HADOOP_VERSION HADOOP_PATH]
[-extjs EXTJS_PATH]
[-jars JARS_PATH] (multiple JAR path separated by ':')
[-secureWeb WEB_XML_PATH] (path to secure web.xml)
```

The original `oozie.war` file is in the Oozie server installation directory.

After the Hadoop JARs and the ExtJS library has been added to the `oozie.war` file Oozie is ready to run.
After the Hadoop JARs has been added to the `oozie.war` file Oozie is ready to run.

Delete any previous deployment of the `oozie.war` from the servlet container (if using Tomcat, delete
`oozie.war` and `oozie` directory from Tomcat's `webapps/` directory)

Deploy the prepared `oozie.war` file (the one that contains the Hadoop JARs and the ExtJS library) in the
Deploy the prepared `oozie.war` file (the one that contains the Hadoop JARs) in the
servlet container (if using Tomcat, copy the prepared `oozie.war` file to Tomcat's `webapps/` directory).

**IMPORTANT:** Only one Oozie instance can be deployed per Tomcat instance.
Expand Down Expand Up @@ -967,14 +963,6 @@ Also, these steps must be done on every machine where you intend to use the Oozi
3. When using the Oozie Client, you will need to use `https://oozie.server.hostname:11443/oozie` instead of
`http://oozie.server.hostname:11000/oozie` -- Java will not automatically redirect from the http address to the https address.
#### Connect to the Oozie Web UI using SSL (HTTPS)
1. Use `https://oozie.server.hostname:11443/oozie`
though most browsers should automatically redirect you if you use `http://oozie.server.hostname:11000/oozie`
**IMPORTANT**: If using a Self-Signed Certificate, your browser will warn you that it can't verify the certificate or something
similar. You will probably have to add your certificate as an exception.
#### Additional considerations for Oozie HA with SSL
You'll need to configure the load balancer to do SSL pass-through. This will allow the clients talking to Oozie to use the
Expand Down Expand Up @@ -1035,12 +1023,10 @@ The deprecated `InstrumentationService` can be enabled by adding `Instrumentatio
```
By default the `admin/instrumentation` REST endpoint is no longer be available and instead the `admin/metrics` endpoint can
be used (see the [Web Services API](WebServicesAPI.html#Oozie_Metrics) documentation for more details); the Oozie Web UI also replaces
the "Instrumentation" tab with a "Metrics" tab.
be used (see the [Web Services API](WebServicesAPI.html#Oozie_Metrics) documentation for more details).
If the deprecated `InstrumentationService` is used, the `admin/instrumentation` REST endpoint gets enabled, the `admin/metrics`
REST endpoint is no longer available (see the [Web Services API](WebServicesAPI.html#Oozie_Metrics) documentation for more details);
the Oozie Web UI also replaces the "Metrics" tab with the "Instrumentation" tab.
REST endpoint is no longer available (see the [Web Services API](WebServicesAPI.html#Oozie_Metrics) documentation for more details).
We can also publish the instrumentation metrics to the external server graphite or ganglia. For this the following
properties should be specified in oozie-site.xml :
Expand Down Expand Up @@ -1195,7 +1181,7 @@ Multiple Oozie Servers can be configured against the same database to provide Hi
8. Start the Oozie servers.
Note: If one of the Oozie servers becomes unavailable, querying Oozie for the logs from a job in the Web UI, REST API, or client may
Note: If one of the Oozie servers becomes unavailable, querying Oozie for the logs from a job via the REST API, or client may
be missing information until that server comes back up.
#### Security
Expand Down
2 changes: 0 additions & 2 deletions docs/src/site/markdown/DG_Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,6 @@ mr-node map-reduce OK end job_200904281535_0254
.----------------------------------------------------------------------------------------------------------------------------------------------------------------
```

To check the workflow job status via the Oozie web console, with a browser go to `http://localhost:11000/oozie`.

To avoid having to provide the `-oozie` option with the Oozie URL with every `oozie` command, set `OOZIE_URL` env
variable to the Oozie URL in the shell environment. For example:

Expand Down
15 changes: 3 additions & 12 deletions docs/src/site/markdown/DG_QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,6 @@ hcatalog libraries, however they are required for oozie to work. There are 2 opt
* Java 1.8+
* Hadoop
* [Apache Hadoop](http://hadoop.apache.org) (tested with 1.2.1 & 2.6.0+)
* ExtJS library (optional, to enable Oozie webconsole)
* [ExtJS 2.2](http://archive.cloudera.com/gplextras/misc/ext-2.2.zip)
The Java 1.8+ `bin` directory should be in the command path.
Expand All @@ -84,11 +82,6 @@ The Java 1.8+ `bin` directory should be in the command path.
* Build an Oozie binary distribution
* Download a Hadoop binary distribution
* Download ExtJS library (it must be version 2.2)
**NOTE:** The ExtJS library is not bundled with Oozie because it uses a different license.
**NOTE:** Oozie UI browser compatibility Chrome (all), Firefox (3.5), Internet Explorer (8.0), Opera (10.5).
**NOTE:** It is recommended to use a Oozie Unix user for the Oozie server.
Expand Down Expand Up @@ -117,8 +110,6 @@ The following two properties are required in Hadoop core-site.xml:
Replace the capital letter sections with specific values and then restart Hadoop.
The ExtJS library is optional (only required for the Oozie web-console to work)
**IMPORTANT:** all Oozie server scripts (`oozie-setup.sh`, `oozied.sh`, `oozie-start.sh`, `oozie-run.sh`
and `oozie-stop.sh`) run only under the Unix user that owns the Oozie installation directory,
if necessary use `sudo -u OOZIE_USER` when invoking the scripts.
Expand All @@ -130,8 +121,8 @@ behaviors of `oozie-start.sh`, `oozie-run.sh`, and `oozie-stop.sh` respectively.
Create a **libext/** directory in the directory where Oozie was expanded.
If using the ExtJS library copy the ZIP file to the **libext/** directory. If hadoop and hcatalog libraries are not
already included in the war, add the corresponding libraries to **libext/** directory.
If hadoop and hcatalog libraries are not already included in the war,
add the corresponding libraries to **libext/** directory.
A "sharelib create -fs fs_default_name [-locallib sharelib]" command is available when running oozie-setup.sh
for uploading new sharelib into hdfs where the first argument is the default fs name
Expand Down Expand Up @@ -205,7 +196,7 @@ Using the Oozie command line tool check the status of Oozie:
$ bin/oozie admin -oozie http://localhost:11000/oozie -status
```
Using a browser go to the [Oozie web console](http://localhost:11000/oozie.html), Oozie status should be **NORMAL**.
The Oozie web console was removed in version 5.3.1.
Refer to the [Running the Examples](DG_Examples.html) document for details on running the examples.
Expand Down
6 changes: 1 addition & 5 deletions docs/src/site/markdown/DG_SLAMonitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ In versions earlier than 4.x, this was a passive feature where users needed to q
to fetch the records regarding job status changes, and use their own custom calculation engine to compute
whether SLA was met or missed, based on initial definition of time limits.

Oozie now also has a SLA tab in the Oozie UI, where users can query for SLA information and have a summarized view
of how their jobs fared against their SLAs.


## Oozie Server Configuration

Expand Down Expand Up @@ -118,7 +115,7 @@ is much more compact and meaningful, getting rid of redundant and unused tags.
* `should-end`: Relative to `nominal-time` this is the amount of time (along with time-unit - MINUTES, HOURS, DAYS) within which your job should *finish* to meet SLA.
* `max-duration`: This is the maximum amount of time (along with time-unit - MINUTES, HOURS, DAYS) your job is expected to run. This is optional.
* `alert-events`: Specify the types of events for which **Email** alerts should be sent. Allowable values in this comma-separated list are start_miss, end_miss and duration_miss. *_met events can generally be deemed low priority and hence email alerting for these is not necessary. However, note that this setting is only for alerts via *email* alerts and not via JMS messages, where all events send out notifications, and user can filter them using desired selectors. This is optional and only applicable when alert-contact is configured.
* `alert-contact`: Specify a comma separated list of email addresses where you wish your alerts to be sent. This is optional and need not be configured if you just want to view your job SLA history in the UI and do not want to receive email alerts.
* `alert-contact`: Specify a comma separated list of email addresses where you wish your alerts to be sent. This is optional and need not be configured if you do not want to receive email alerts.

NOTE: All tags can be parameterized as a EL function or a fixed value.

Expand Down Expand Up @@ -167,7 +164,6 @@ can be applied to and embedded under Workflow-Action as well as Coordinator-Acti

SLA information is accessible via the following ways:

* Through the SLA tab of the Oozie Web UI.
* JMS messages sent to a configured JMS provider for instantaneous tracking.
* RESTful API to query for SLA summary.
* As an `Instrumentation.Counter` entry that is accessible via RESTful API and reflects to the number of all SLA tracked external
Expand Down
3 changes: 0 additions & 3 deletions docs/src/site/markdown/DG_ShellActionExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,6 @@ log4j.appender.console.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} %p %c{2}:

Shell action's stdout and stderr output are redirected to the Oozie Launcher map-reduce job task STDOUT that runs the shell command.

From Oozie web-console, from the Shell action pop up using the 'Console URL' link, it is possible
to navigate to the Oozie Launcher map-reduce job task logs via the Hadoop job-tracker web-console.

### Shell Action Limitations
Although Shell action can execute any shell command, there are some limitations.

Expand Down
3 changes: 0 additions & 3 deletions docs/src/site/markdown/DG_SparkActionExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,6 @@ expressions.

Spark action logs are redirected to the Oozie Launcher map-reduce job task STDOUT/STDERR that runs Spark.

From Oozie web-console, from the Spark action pop up using the 'Console URL' link, it is possible
to navigate to the Oozie Launcher map-reduce job task logs via the Hadoop job-tracker web-console.

### Spark on YARN

To ensure that your Spark job shows up in the Spark History Server, make sure to specify these three Spark configuration properties
Expand Down
3 changes: 0 additions & 3 deletions docs/src/site/markdown/DG_SqoopActionExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,6 @@ of all map-reduce jobs run by the Sqoop import all command.

Sqoop action logs are redirected to the Oozie Launcher map-reduce job task STDOUT/STDERR that runs Sqoop.

From Oozie web-console, from the Sqoop action pop up using the 'Console URL' link, it is possible
to navigate to the Oozie Launcher map-reduce job task logs via the Hadoop job-tracker web-console.

The logging level of the Sqoop action can set in the Sqoop action configuration using the
property `oozie.sqoop.log.level`. The default value is `INFO`.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/site/markdown/WebServicesAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -1794,7 +1794,7 @@ This parameter has no effect when workflow fails and the failure node leads to t
always.

The optional `format` parameter describes whether the response has to be rendered as a PNG image, or an SVG image, or a DOT string.
When omitted, `format` is considered as `png` for backwards compatibility. Oozie Web UI uses the `svg` `format`.
When omitted, `format` is considered as `png` for backwards compatibility.

The node labels are the node names provided in the workflow XML.

Expand Down
Loading

0 comments on commit 670689b

Please sign in to comment.