Skip to content
This repository was archived by the owner on Oct 23, 2024. It is now read-only.

Commit 62f7a5a

Browse files
kvishtakirala
authored andcommitted
Update docs to drop all executor artifact references (#2809)
1 parent a35a115 commit 62f7a5a

File tree

8 files changed

+13
-20
lines changed

8 files changed

+13
-20
lines changed

build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
set -e
33

44
usage() {
5-
# This script does a full build/test of the SDK's own artifacts: bootstrap, executor, and default CLI
5+
# This script does a full build/test of the SDK's own artifacts: bootstrap and default CLI
66
# This does not upload the artifacts, instead see test.sh or frameworks/*/build.sh.
77
# This script (and test.sh) are executed by CI upon pull requests to the repository, or may be run locally by developers.
88
echo "Syntax: build.sh [options]"

docs/pages/developer-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ For a fully detailed explanation of service packaging [see here](https://dcos.io
526526

527527
* `marathon.json.mustache` - A mustache-templated file that provides a Marathon application definition. Its mustache elements are rendered by the values present in the config.json and resource.json files.
528528

529-
* `resource.json` - A list of URIs of all downloaded elements. Any artifacts needed by your service _must_ be listed here, or else your service will fail to install to airgapped clusters. When an airgapped cluster installs your package, only the files listed here will be available. This list contains some items required in order for the service to run, such as `bootstrap.zip` (bootstrap utility described elsewhere in this guide) and `executor.zip` (custom executor for DC/OS 1.9 compatibility).
529+
* `resource.json` - A list of URIs of all downloaded elements. Any artifacts needed by your service _must_ be listed here, or else your service will fail to install to airgapped clusters. When an airgapped cluster installs your package, only the files listed here will be available. This list contains some items required in order for the service to run along with `bootstrap.zip` (bootstrap utility described elsewhere in this guide).
530530

531531
* `command.json` - This file contains elements specific to a CLI for your service if you want to provide one.
532532

frameworks/cassandra/build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ set -e
44
FRAMEWORK_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
55
REPO_ROOT_DIR=$(dirname $(dirname $FRAMEWORK_DIR))
66

7-
# Build SDK artifacts (executor, clis, bootstrap) to be included in our release, but skip SDK tests
8-
# since since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
7+
# Build SDK artifacts (clis, bootstrap) to be included in our release, but skip SDK tests
8+
# since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
99
# this step, and should omit the "REPO_ROOT_DIR" artifacts listed below.
1010
$REPO_ROOT_DIR/build.sh -b
1111

frameworks/elastic/build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ REPO_ROOT_DIR=$(dirname $(dirname $FRAMEWORK_DIR))
77
# grab TEMPLATE_x vars for use in universe template:
88
source $FRAMEWORK_DIR/versions.sh
99

10-
# Build SDK artifacts (executor, clis, bootstrap) to be included in our release, but skip SDK tests
11-
# since since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
10+
# Build SDK artifacts (clis, bootstrap) to be included in our release, but skip SDK tests
11+
# since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
1212
# this step, and should omit the "REPO_ROOT_DIR" artifacts listed below.
1313
$REPO_ROOT_DIR/build.sh -b
1414

frameworks/hdfs/build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ set -e
44
FRAMEWORK_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
55
REPO_ROOT_DIR=$(dirname $(dirname $FRAMEWORK_DIR))
66

7-
# Build SDK artifacts (executor, clis, bootstrap) to be included in our release, but skip SDK tests
8-
# since since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
7+
# Build SDK artifacts (clis, bootstrap) to be included in our release, but skip SDK tests
8+
# since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
99
# this step, and should omit the "REPO_ROOT_DIR" artifacts listed below.
1010
$REPO_ROOT_DIR/build.sh -b
1111

frameworks/helloworld/build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ set -e
44
FRAMEWORK_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
55
REPO_ROOT_DIR=$(dirname $(dirname $FRAMEWORK_DIR))
66

7-
# Build SDK artifacts (executor, clis, bootstrap) to be included in our release, but skip SDK tests
8-
# since since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
7+
# Build SDK artifacts (clis, bootstrap) to be included in our release, but skip SDK tests
8+
# since that's not in our scope. Projects that aren't colocated in dcos-commons should skip
99
# this step, and should omit the "REPO_ROOT_DIR" artifacts listed below.
1010
$REPO_ROOT_DIR/build.sh -b
1111

sdk/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
This directory contains most of the SDK bits that would be used in a running service. The contents of this directory are briefly described below.
44

5-
## scheduler/, executor/, common/
5+
## scheduler/
66

7-
- `scheduler/`: The main SDK Scheduler code. This is the "service manager" for SDK-based services, which handles keeping the service itself running.
8-
- `executor/`: The 'custom executor', which is provided for compatibility with DC/OS 1.9 and older. DC/OS 1.10+ instead use a Default Scheduler provided by Mesos itself.
9-
- `common/`: A Java library containing a small amount of code that's common between `scheduler/` and `executor/`.
7+
The main SDK Scheduler code. This is the "service manager" for SDK-based services, which handles keeping the service itself running.
108

119
## testing/
1210

tools/distribution/UPDATING.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ This framework is built using the [DC/OS Commons SDK](https://github.com/mesosph
55
The parts of the SDK consumed consist of:
66
* The SDK Java libraries including:
77
* scheduler libraries
8-
* executor libraries
98
* testing libraries
10-
* SDK artefacts including:
11-
* The custom executor for use on DC/OS 1.9 clusters
9+
* SDK artifacts including:
1210
* The `bootstrap` utility
1311
* CLI binaries for the three supported platforms
1412
* Build tooling
@@ -24,7 +22,6 @@ Check that `build.gradle` in the project root contains the following dependencie
2422
```
2523
dependencies {
2624
compile "mesosphere:scheduler:${dcosSDKVer}"
27-
compile "mesosphere:executor:${dcosSDKVer}"
2825
testCompile "mesosphere:testing:${dcosSDKVer}"
2926
}
3027
```
@@ -38,7 +35,6 @@ ext {
3835

3936
Older versions of `build.gradle` contained the following dependencies and no entry in the `ext` specification:
4037
* `compile "mesosphere:scheduler:<CURRENT_SDK_VERSION>"`
41-
* `compile "mesosphere:executor:<CURRENT_SDK_VERSION>"`
4238
* `testCompile "mesosphere:testing:<CURRENT_SDK_VERSION>"`
4339

4440
Although this is supported in the current upgrade path, it is recommended that hese are changed to match the dependencies at the start of this section as this will result in a single line diff in the `build.gradle` file on update.
@@ -51,7 +47,6 @@ In order to facilitate upgrades, the `universe/resource.json` file should contai
5147
"uris": {
5248
"...": "...",
5349
"bootstrap-zip": "https://downloads.mesosphere.com/dcos-commons/artifacts/{{dcos-sdk-version}}/bootstrap.zip",
54-
"executor-zip": "http://downloads.mesosphere.com/dcos-commons/artifacts/{{dcos-sdk-version}}/executor.zip",
5550
"...": "..."
5651
}
5752
```

0 commit comments

Comments
 (0)