Skip to content

Commit

Permalink
Fix documentation formatting errors
Browse files Browse the repository at this point in the history
  • Loading branch information
tgianos committed May 14, 2021
1 parent 58d86b7 commit 669ac5d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion genie-docs/src/docs/asciidoc/_properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ This section describes the various properties that can be set to control the beh
Unless otherwise noted, properties are loaded from the standard sources (defaults, profiles, other files).
The server also has a chance to override them during the 'Agent Configuration' execution stage.

==== Properties forwarding
=== Properties forwarding

Server-side properties that match a given prefix are forwarded to all agents during agent configuration stage.
For a property to be forwarded, it needs to be prefixed with `genie.agent.configuration.dynamic.`.
Expand Down
14 changes: 8 additions & 6 deletions genie-docs/src/docs/asciidoc/concepts/_intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This section provides an high level overview of what a Genie job is.
More details on the concepts covered here are provided in later sections.

===== API jobs vs agent CLI jobs
==== API jobs vs agent CLI jobs

Genie provides 2 ways to execute a job:

Expand All @@ -16,15 +16,16 @@ The server takes care of all the details, the user can sit back, wait for the jo

A job request via API may look something like this:

```
[source]
----
{
"command" : ["type:spark-sql", "version:2.1.1"],
"cluster" : ["data:production"],
"arguments" : "-e 'select count(*) from some_table'"
"memory" : 1024,
"user" : "jdoe"
}
```
----

The advantages of API jobs are:

Expand All @@ -38,12 +39,13 @@ Genie for configuration, monitoring, audit, archival, etc.

An agent job launched via CLI may look something like this:

```
[source]
----
$ genie-agent exec \
--command='type:spark-shell'
--cluster='data:test' \
-- --shell-color=true'
```
----

There are two primary reasons for choosing agent CLI over API job request:

Expand Down Expand Up @@ -82,7 +84,7 @@ image::4.0.0/cli-job.png[CLI Job, link="{imagesdir}/4.0.0/cli-job.png"]
1. The user launches a job via CLI (this job execute locally, wherever the agent is invoked)
2. The agent connects to the Genie cluster and creates the job record, resolves resources (cluster, command). It also keeps the server informed of its progress.
3. The agent sets up the job (downloads dependencies, runs setup scripts, ...), then launches it, all while regularly updating the server. After the job is done, the agent archives outputs and logs.
6. While the job is running and after completion, the user can retrieve job status and download outputs and logs (and even kill the job).
4. While the job is running and after completion, the user can retrieve job status and download outputs and logs (and even kill the job).

===== Status Transitions

Expand Down

0 comments on commit 669ac5d

Please sign in to comment.