openstack
/
deb-python-dcos
Code Issues Proposed changes

DC slash OS (#637)

This commit is contained in:
Harpreet Singh Gulati 2016-06-07 11:16:04 -07:00 committed by tamarrow
parent 9e10cd21b8
commit 3756706acf
64 changed files with 183 additions and 182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -1,4 +1,4 @@
# Contribution Guide for the DCOS-CLI
# Contribution Guide for the DC/OS CLI
Thanks for contributing! Here are a few guidelines to get you started.
@ -8,7 +8,7 @@ Please file feature requests and bugs through Github issues.
If you are submitting a bug report, please include:
- dcos cli version: `dcos --version`
- DCOS version
- DC/OS version
- operating system
- command that errored with `--log-level=debug --debug`
@ -34,4 +34,4 @@ locally.
## Thanks!
The DCOS-CLI Team
The DC/OS CLI Team

10
DESCRIPTION.rst
View File

@ -1,11 +1,11 @@
DCOS Command Line Interface
DC/OS Command Line Interface
===========================
The DCOS Command Line Interface (CLI) is a command line utility that
provides a user-friendly yet powerful way to manage DCOS installations.
The DC/OS Command Line Interface (CLI) is a command line utility that
provides a user-friendly yet powerful way to manage DC/OS installations.
This project is open source. Please see GitHub_ to access source code and to contribute.
Full documentation is available for the DCOS CLI on the `DCOS docs website`_.
Full documentation is available for the DC/OS CLI on the `DC/OS docs website`_.
.. _GitHub: https://github.com/mesosphere/dcos-cli
.. _DCOS docs website: https://dcos.io/docs/usage/cli/
.. _DC/OS docs website: https://dcos.io/docs/usage/cli/

4
ISSUE_TEMPLATE.md
View File

@ -1,7 +1,7 @@
Please answer the following questions before submitting your issue. Thanks!
### What version of DCOS + DCOS CLI are you using (`dcos --version`)?
If DCOS CLI version < 0.4.5, DCOS version can be found at `http://dcos_url/dcos-metada/dcos-version.json`
### What version of DC/OS + DC/OS CLI are you using (`dcos --version`)?
If DC/OS CLI version < 0.4.5, DC/OS version can be found at `http://dcos_url/dcos-metada/dcos-version.json`
### What operating system and version are you using?

28
README.rst
View File

@ -1,18 +1,18 @@
DCOS Command Line Interface
DC/OS Command Line Interface
===========================
The DCOS Command Line Interface (CLI) is a cross-platform command line utility
that provides a user-friendly yet powerful way to manage DCOS installations.
The DC/OS Command Line Interface (CLI) is a cross-platform command line utility
that provides a user-friendly yet powerful way to manage DC/OS installations.
Installation and Usage
----------------------
If you're a **user** of DCOS, please follow the `installation instructions`_.
If you're a **user** of DC/OS, please follow the `installation instructions`_.
Otherwise, follow the instructions below to set up your development environment.
Detailed help and usage information is available through the :code:`dcos help`
command and for specific subcommands through :code:`dcos <subcommand> --help`.
Additional documentation for the CLI and for the DCOS in general is available
Additional documentation for the CLI and for the DC/OS in general is available
in the `Mesosphere docs`_.
Parsing CLI Output
@ -23,20 +23,20 @@ all of your favourite Unix/Linux tools like sed, awk and grep, or text formatted
as JSON when using the :code:`--json` flag.
If using JSON, you can combine it with the powerful jq_ utility.
The example below installs every package available in the DCOS repository::
The example below installs every package available in the DC/OS repository::
dcos package search --json | jq '.[0].packages[].name' | xargs -L 1 dcos package install --yes
Using the CLI without DCOS
Using the CLI without DC/OS
--------------------------
You may optionally configure the DCOS CLI to work with open source Mesos and
You may optionally configure the DC/OS CLI to work with open source Mesos and
Marathon_ by setting the following properties::
dcos config set core.mesos_master_url http://<mesos-master-host>:5050
dcos config set marathon.url http://<marathon-host>:8080
Note that the DCOS CLI has tight integration with DCOS and certain
Note that the DC/OS CLI has tight integration with DC/OS and certain
functionality may not work as expected or at all when using it directly with
Mesos and Marathon.
@ -87,11 +87,11 @@ Configure Environment and Run
source bin/env-setup-dev
#. Configure the CLI, changing the values below as appropriate for your local
installation of DCOS::
installation of DC/OS::
dcos config set core.dcos_url http://dcos-ea-1234.us-west-2.elb.amazonaws.com
#. Get started by calling the DCOS CLI help::
#. Get started by calling the DC/OS CLI help::
dcos help
@ -110,7 +110,7 @@ Running
Tox will run unit and integration tests in both Python environments using a
temporarily created virtualenv.
You can set :code:`DCOS_CONFIG` to a config file that points to a DCOS
You can set :code:`DCOS_CONFIG` to a config file that points to a DC/OS
cluster you want to use for integration tests. This defaults to
:code:`~/.dcos/dcos.toml`
@ -142,7 +142,7 @@ Other Useful Commands
Releasing
#########
Releasing a new version of the DCOS CLI is only possible through an `automated TeamCity build`_ which is triggered automatically when a new tag is added.
Releasing a new version of the DC/OS CLI is only possible through an `automated TeamCity build`_ which is triggered automatically when a new tag is added.
The tag is used as the version number and must adhere to the conventional `PEP-440 version scheme`_.
@ -152,7 +152,7 @@ Once all tests pass successfully, the automated build publishes two packages to
#. dcoscli_
These packages are now available to be installed by the DCOS CLI installation script in the `mesosphere/install-scripts`_ repository.
These packages are now available to be installed by the DC/OS CLI installation script in the `mesosphere/install-scripts`_ repository.
.. _automated TeamCity build: https://teamcity.mesosphere.io/viewType.html?buildTypeId=ClosedSource_DcosCli_PushToPyPI

8
bin/install/install-dcos-cli.sh
View File

@ -9,7 +9,7 @@ usage()
post_install_message()
{
echo 'Finished installing and configuring DCOS CLI.'
echo 'Finished installing and configuring DC/OS CLI.'
echo ''
echo 'Run this command to set up your environment and to get started:'
echo "source $1 && dcos help"
@ -20,7 +20,7 @@ RC_NAME=""
write_to_profile()
{
echo "" >> ~/"$2";
echo "# path to the DCOS CLI binary" >> ~/"$2";
echo "# path to the DC/OS CLI binary" >> ~/"$2";
echo "if [[ \"\$PATH\" != *\"$1\"* ]];" >> ~/"$2";
echo " then export PATH=\$PATH:$1;" >> ~/"$2";
echo "fi" >> ~/"$2";
@ -127,7 +127,7 @@ if [ $MAJOR -lt 12 ];
exit 1;
fi
echo "Installing DCOS CLI from PyPI...";
echo "Installing DC/OS CLI from PyPI...";
echo "";
if [ "$(validate_dcos_url)" -gt 0 ]; then
@ -147,7 +147,7 @@ mkdir -p "$VIRTUAL_ENV_PATH"
virtualenv "$VIRTUAL_ENV_PATH"
# Install the DCOS CLI package, using version if set
# Install the DC/OS CLI package, using version if set
if [ -z "$DCOS_CLI_VERSION" ]; then
if $(compare_version 1.6.1); then
"$VIRTUAL_ENV_PATH/bin/pip" install --quiet "dcoscli<0.4.0"

8
bin/install/install-optout-dcos-cli.sh
View File

@ -9,7 +9,7 @@ usage()
post_install_message()
{
echo 'Finished installing and configuring DCOS CLI.'
echo 'Finished installing and configuring DC/OS CLI.'
echo ''
echo 'Run this command to set up your environment and to get started:'
echo "source $1 && dcos help"
@ -20,7 +20,7 @@ RC_NAME=""
write_to_profile()
{
echo "" >> ~/"$2";
echo "# path to the DCOS CLI binary" >> ~/"$2";
echo "# path to the DC/OS CLI binary" >> ~/"$2";
echo "if [[ \"\$PATH\" != *\"$1\"* ]];" >> ~/"$2";
echo " then export PATH=\$PATH:$1;" >> ~/"$2";
echo "fi" >> ~/"$2";
@ -127,7 +127,7 @@ if [ $MAJOR -lt 12 ];
exit 1;
fi
echo "Installing DCOS CLI from PyPI...";
echo "Installing DC/OS CLI from PyPI...";
echo "";
if [ "$(validate_dcos_url)" -gt 0 ]; then
@ -147,7 +147,7 @@ mkdir -p "$VIRTUAL_ENV_PATH"
virtualenv "$VIRTUAL_ENV_PATH"
# Install the DCOS CLI package, using version if set
# Install the DC/OS CLI package, using version if set
if [ -z "$DCOS_CLI_VERSION" ]; then
if $(compare_version 1.6.1); then
"$VIRTUAL_ENV_PATH/bin/pip" install --quiet "dcoscli<0.4.0"

8
bin/install/legacy/install-legacy-dcos-cli.sh
View File

@ -9,7 +9,7 @@ usage()
post_install_message()
{
echo 'Finished installing and configuring DCOS CLI.'
echo 'Finished installing and configuring DC/OS CLI.'
echo ''
echo 'Run this command to set up your environment and to get started:'
echo "source $1 && dcos help"
@ -20,7 +20,7 @@ RC_NAME=""
write_to_profile()
{
echo "" >> ~/"$2";
echo "# path to the DCOS CLI binary" >> ~/"$2";
echo "# path to the DC/OS CLI binary" >> ~/"$2";
echo "if [[ \"\$PATH\" != *\"$1\"* ]];" >> ~/"$2";
echo " then export PATH=\$PATH:$1;" >> ~/"$2";
echo "fi" >> ~/"$2";
@ -109,14 +109,14 @@ if [ $MAJOR -lt 12 ];
exit 1;
fi
echo "Installing DCOS CLI from PyPI...";
echo "Installing DC/OS CLI from PyPI...";
echo "";
# Let's first setup a virtualenv: we are assuming that the path is absolute
mkdir -p "$VIRTUAL_ENV_PATH"
virtualenv "$VIRTUAL_ENV_PATH"
# Install the DCOS CLI package, using version if set
# Install the DC/OS CLI package, using version if set
if [ -z "$DCOS_CLI_VERSION" ]; then
"$VIRTUAL_ENV_PATH/bin/pip" install --quiet "dcoscli<0.4.0"
else

10
bin/install/legacy/install-legacy-optout-dcos-cli.sh
View File

@ -9,7 +9,7 @@ usage()
post_install_message()
{
echo 'Finished installing and configuring DCOS CLI.'
echo 'Finished installing and configuring DC/OS CLI.'
echo ''
echo 'Run this command to set up your environment and to get started:'
echo "source $1 && dcos help"
@ -20,7 +20,7 @@ RC_NAME=""
write_to_profile()
{
echo "" >> ~/"$2";
echo "# path to the DCOS CLI binary" >> ~/"$2";
echo "# path to the DC/OS CLI binary" >> ~/"$2";
echo "if [[ \"\$PATH\" != *\"$1\"* ]];" >> ~/"$2";
echo " then export PATH=\$PATH:$1;" >> ~/"$2";
echo "fi" >> ~/"$2";
@ -43,7 +43,7 @@ prompt_add_dcos_path_to_profile()
{
while true; do
echo ""
read -p "Modify your bash profile to add DCOS to your PATH? [yes/no] " ANSWER
read -p "Modify your bash profile to add DC/OS to your PATH? [yes/no] " ANSWER
echo ""
case "$ANSWER" in
[Yy]* ) add_dcos_path_to_profile "$1"; break;;
@ -109,14 +109,14 @@ if [ $MAJOR -lt 12 ];
exit 1;
fi
echo "Installing DCOS CLI from PyPI...";
echo "Installing DC/OS CLI from PyPI...";
echo "";
# Let's first setup a virtualenv: we are assuming that the path is absolute
mkdir -p "$VIRTUAL_ENV_PATH"
virtualenv "$VIRTUAL_ENV_PATH"
# Install the DCOS CLI package, using version if set
# Install the DC/OS CLI package, using version if set
if [ -z "$DCOS_CLI_VERSION" ]; then
"$VIRTUAL_ENV_PATH/bin/pip" install --quiet "dcoscli<0.4.0"
else

2
ccm/start_ccm_cluster.sh
View File

@ -15,7 +15,7 @@ CLUSTER_ID=$(http --ignore-stdin \https://ccm.mesosphere.com/api/cluster/ \
region=us-west-2 \
time=120 \
channel=$DCOS_CHANNEL \
cluster_desc="DCOS CLI testing cluster" \
cluster_desc="DC/OS CLI testing cluster" \
template=single-master.cloudformation.json \
adminlocation=0.0.0.0/0 \
public_agents=0 \

8
cli/DESCRIPTION.rst
View File

@ -1,11 +1,11 @@
DCOS Command Line Interface
DC/OS Command Line Interface
===========================
The DCOS Command Line Interface (CLI) is a command line utility that
provides a user-friendly yet powerful way to manage DCOS installations.
The DC/OS Command Line Interface (CLI) is a command line utility that
provides a user-friendly yet powerful way to manage DC/OS installations.
This project is open source. Please see GitHub_ to access source code and to contribute.
Full documentation is available for the DCOS CLI on the `Mesosphere docs website`_.
Full documentation is available for the DC/OS CLI on the `Mesosphere docs website`_.
.. _GitHub: https://github.com/mesosphere/dcos-cli
.. _Mesosphere docs website: https://dcos.io/docs/usage/cli/

2
cli/dcoscli/__init__.py
View File

@ -1,4 +1,4 @@
# Version is set for releases by our build system.
# Be extremely careful when modifying.
version = 'SNAPSHOT'
"""DCOS CLI version"""
"""DC/OS CLI version"""

2
cli/dcoscli/auth/main.py
View File

@ -77,7 +77,7 @@ def _login():
_logout()
dcos_url = config.get_config_val("core.dcos_url")
if dcos_url is None:
msg = ("Please provide the url to your DCOS cluster: "
msg = ("Please provide the url to your DC/OS cluster: "
"`dcos config set core.dcos_url`")
raise DCOSException(msg)

6
cli/dcoscli/data/help/auth.txt
View File

@ -1,5 +1,5 @@
Description:
Authenticate to DCOS cluster
Authenticate to DC/OS cluster
Usage:
dcos auth --help
@ -9,9 +9,9 @@ Usage:
Commands:
login
Login to your DCOS Cluster.
Login to your DC/OS Cluster.
logout
Logout of your DCOS Cluster.
Logout of your DC/OS Cluster.
Options:
-h, --help

6
cli/dcoscli/data/help/config.txt
View File

@ -1,5 +1,5 @@
Description:
Manage the DCOS configuration file.
Manage the DC/OS configuration file.
Usage:
dcos config --help
@ -11,9 +11,9 @@ Usage:
Commands:
set
Add or set a DCOS configuration property.
Add or set a DC/OS configuration property.
show
Print the DCOS configuration file contents.
Print the DC/OS configuration file contents.
unset
Remove a property from the configuration file.
validate

4
cli/dcoscli/data/help/dcos.txt
View File

@ -1,5 +1,5 @@
Description:
The Mesosphere Datacenter Operating System (DCOS) spans all of the machines in
The Mesosphere Datacenter Operating System (DC/OS) spans all of the machines in
your datacenter or cloud and treats them as a single, shared set of resources.
Usage:
@ -24,7 +24,7 @@ Options:
Environment Variables:
DCOS_CONFIG
Set the path to the DCOS configuration file. By default, this variable
Set the path to the DC/OS configuration file. By default, this variable
is set to ~/.dcos/dcos.toml.
DCOS_DEBUG
Indicates whether to print additional debug messages to stdout. By

2
cli/dcoscli/data/help/help.txt
View File

@ -1,5 +1,5 @@
Description:
Display help information about DCOS.
Display help information about DC/OS.
Usage:
dcos help

4
cli/dcoscli/data/help/marathon.txt
View File

@ -1,5 +1,5 @@
Description:
Deploy and manage applications to DCOS.
Deploy and manage applications to DC/OS.
Usage:
dcos marathon --config-schema
@ -33,7 +33,7 @@ Usage:
Commands:
about
Print info.json for DCOS Marathon.
Print info.json for DC/OS Marathon.
app add
Add an application.
app list

6
cli/dcoscli/data/help/node.txt
View File

@ -1,5 +1,5 @@
Description:
Administer and manage DCOS cluster nodes.
Administer and manage DC/OS cluster nodes.
Usage:
dcos node --help
@ -17,7 +17,7 @@ Commands:
log
Prints the Mesos logs for the leading master node, agent nodes, or both.
ssh
Establish an SSH connection to the master or agent nodes of your DCOS
Establish an SSH connection to the master or agent nodes of your DC/OS
cluster.
Options:
@ -39,7 +39,7 @@ Options:
Deprecated. Please use --leader.
--master-proxy
Proxy the SSH connection through a master node. This can be useful when
accessing DCOS from a separate network. For example, in the default AWS
accessing DC/OS from a separate network. For example, in the default AWS
configuration, the private slaves are unreachable from the public
internet. You can access them using this option, which will first hop
from the publicly available master.

10
cli/dcoscli/data/help/package.txt
View File

@ -1,5 +1,5 @@
Description:
Install and manage DCOS software packages.
Install and manage DC/OS software packages.
Usage:
dcos package --config-schema
@ -31,13 +31,13 @@ Commands:
install
Install a package.
list
Print a list of the installed DCOS packages.
Print a list of the installed DC/OS packages.
search
Search the package repository.
repo add
Add a package repository to DCOS.
Add a package repository to DC/OS.
repo remove
Remove a package repository from DCOS.
Remove a package repository from DC/OS.
repo list
Print the package repository sources. Possible sources include a local
file, HTTPS, and Git.
@ -82,7 +82,7 @@ Options:
Positional Arguments:
<package-name>
Name of the DCOS package in the package repository.
Name of the DC/OS package in the package repository.
<query>
Pattern to use for searching the package repository. You can use
complete or partial values.

8
cli/dcoscli/data/help/service.txt
View File

@ -1,5 +1,5 @@
Description:
Manage DCOS services.
Manage DC/OS services.
Usage:
dcos service --help
@ -31,7 +31,7 @@ Options:
--info
Print a short description of this subcommand.
--json
Print JSON-formatted list of DCOS services.
Print JSON-formatted list of DC/OS services.
--lines=N
Print the last N lines, where 10 is the default.
--ssh-config-file=<path>
@ -44,6 +44,6 @@ Positional Arguments:
<file>
The service log filename for the Mesos sandbox. The default is stdout.
<service>
The DCOS Service name.
The DC/OS Service name.
<service-id>
The DCOS Service ID.
The DC/OS Service ID.

2
cli/dcoscli/data/help/task.txt
View File

@ -1,5 +1,5 @@
Description:
Manage DCOS tasks.
Manage DC/OS tasks.
Usage:
dcos task --help

6
cli/dcoscli/help/main.py
View File

@ -83,10 +83,10 @@ def _help(command):
emitter.publish(
"Command line utility for the Mesosphere Datacenter Operating\n"
"System (DCOS). The Mesosphere DCOS is a distributed operating\n"
"System (DC/OS). The Mesosphere DC/OS is a distributed operating\n"
"system built around Apache Mesos. This utility provides tools\n"
"for easy management of a DCOS installation.\n")
emitter.publish("Available DCOS commands:")
"for easy management of a DC/OS installation.\n")
emitter.publish("Available DC/OS commands:")
emitter.publish(commands_message)
emitter.publish(
"\nGet detailed command description with 'dcos <command> --help'.")

4
cli/dcoscli/main.py
View File

@ -23,9 +23,9 @@ def main():
def _get_versions(dcos_url):
"""Print DCOS and DCOS-CLI versions
"""Print DC/OS and DC/OS-CLI versions
:param dcos_url: url to DCOS cluster
:param dcos_url: url to DC/OS cluster
:type dcos_url: str
:returns: Process status
:rtype: int

7
cli/dcoscli/node/main.py
View File

@ -83,7 +83,7 @@ def _info():
def _list(json_):
"""List DCOS nodes
"""List DC/OS nodes
:param json_: If true, output json.
Otherwise, output a human readable table.
@ -156,7 +156,7 @@ def _mesos_files(leader, slave_id):
def _ssh(leader, slave, option, config_file, user, master_proxy, command):
"""SSH into a DCOS node using the IP addresses found in master's
"""SSH into a DC/OS node using the IP addresses found in master's
state.json
:param leader: True if the user has opted to SSH into the leading
@ -227,6 +227,7 @@ def _ssh(leader, slave, option, config_file, user, master_proxy, command):
if (not master_proxy) and master_public_ip:
emitter.publish(
DefaultError("If you are running this command from a separate "
"network than DCOS, consider using `--master-proxy`"))
"network than DC/OS, consider using "
"`--master-proxy`"))
return subprocess.call(cmd, shell=True)

2
cli/dcoscli/package/main.py
View File

@ -545,7 +545,7 @@ def _get_package_manager():
if cosmos_manager.enabled():
return cosmos_manager
else:
msg = ("This version of the DCOS CLI is not supported for your "
msg = ("This version of the DC/OS CLI is not supported for your "
"cluster. Please downgrade the CLI to an older version: "
"https://dcos.io/docs/usage/cli/update/#downgrade"
)

6
cli/dcoscli/subcommand.py
View File

@ -34,7 +34,7 @@ def _default_modules():
def default_doc(command):
"""Returns documentation of command
:param command: default DCOS-CLI command
:param command: default DC/OS CLI command
:type command: str
:returns: config schema of command
:rtype: dict
@ -47,7 +47,7 @@ def default_doc(command):
def default_command_info(command):
"""top level documentation of default DCOS-CLI command
"""top level documentation of default DC/OS CLI command
:param command: name of command
:param type: str
@ -60,7 +60,7 @@ def default_command_info(command):
def default_command_documentation(command):
"""documentation of default DCOS-CLI command
"""documentation of default DC/OS CLI command
:param command: name of command
:param type: str

8
cli/dcoscli/tables.py
View File

@ -184,7 +184,7 @@ def deployment_table(deployments):
def service_table(services):
"""Returns a PrettyTable representation of the provided DCOS services.
"""Returns a PrettyTable representation of the provided DC/OS services.
:param services: services to render
:type services: [Framework]
@ -258,7 +258,7 @@ def group_table(groups):
def package_table(packages):
"""Returns a PrettyTable representation of the provided DCOS packages
"""Returns a PrettyTable representation of the provided DC/OS packages
:param packages: packages to render
:type packages: [dict]
@ -287,7 +287,7 @@ def package_table(packages):
def package_search_table(search_results):
"""Returns a PrettyTable representation of the provided DCOS package
"""Returns a PrettyTable representation of the provided DC/OS package
search results
:param search_results: search_results, in the format of
@ -322,7 +322,7 @@ def package_search_table(search_results):
def slave_table(slaves):
"""Returns a PrettyTable representation of the provided DCOS slaves
"""Returns a PrettyTable representation of the provided DC/OS slaves
:param slaves: slaves to render. dicts from /mesos/state-summary
:type slaves: [dict]

2
cli/dcoscli/task/main.py
View File

@ -214,7 +214,7 @@ def _mesos_files(tasks, file_, client):
:type tasks: [mesos.Task]
:param file_: file path to read
:type file_: str
:param client: DCOS client
:param client: DC/OS client
:type client: mesos.DCOSClient
:returns: MesosFile objects
:rtype: [mesos.MesosFile]

2
cli/requirements.txt
View File

@ -2,4 +2,4 @@ sphinx>=1.3.1, <2.0
tox>=2.2, <3.0
wheel>=0.24.0, <1.0
pytest>=2.9.1
-e .. # Install the DCOS package
-e .. # Install the DC/OS package

2
cli/setup.py
View File

@ -18,7 +18,7 @@ setup(
# https://packaging.python.org/en/latest/single_source_version.html
version=dcoscli.version,
description='DCOS Command Line Interface',
description='DC/OS Command Line Interface',
long_description=long_description,
# The project's main homepage.

2
cli/tests/data/dcos.toml
View File

@ -1,5 +1,5 @@
[core]
dcos_url = "http://dcos.snakeoil.mesosphere.com"
timeout = 5
reporting = false
dcos_url = "http://dcos.snakeoil.mesosphere.com"
ssl_verify = "false"

6
cli/tests/data/help/auth.txt
View File

@ -1,5 +1,5 @@
Description:
Authenticate to DCOS cluster
Authenticate to DC/OS cluster
Usage:
dcos auth --help
@ -9,9 +9,9 @@ Usage:
Commands:
login
Login to your DCOS Cluster.
Login to your DC/OS Cluster.
logout
Logout of your DCOS Cluster.
Logout of your DC/OS Cluster.
Options:
-h, --help

6
cli/tests/data/help/config.txt
View File

@ -1,5 +1,5 @@
Description:
Manage the DCOS configuration file.
Manage the DC/OS configuration file.
Usage:
dcos config --help
@ -11,9 +11,9 @@ Usage:
Commands:
set
Add or set a DCOS configuration property.
Add or set a DC/OS configuration property.
show
Print the DCOS configuration file contents.
Print the DC/OS configuration file contents.
unset
Remove a property from the configuration file.
validate

4
cli/tests/data/help/dcos.txt
View File

@ -1,5 +1,5 @@
Description:
The Mesosphere Datacenter Operating System (DCOS) spans all of the machines in
The Mesosphere Datacenter Operating System (DC/OS) spans all of the machines in
your datacenter or cloud and treats them as a single, shared set of resources.
Usage:
@ -24,7 +24,7 @@ Options:
Environment Variables:
DCOS_CONFIG
Set the path to the DCOS configuration file. By default, this variable
Set the path to the DC/OS configuration file. By default, this variable
is set to ~/.dcos/dcos.toml.
DCOS_DEBUG
Indicates whether to print additional debug messages to stdout. By

22
cli/tests/data/help/default.txt
View File

@ -1,17 +1,17 @@
Command line utility for the Mesosphere Datacenter Operating
System (DCOS). The Mesosphere DCOS is a distributed operating
System (DC/OS). The Mesosphere DC/OS is a distributed operating
system built around Apache Mesos. This utility provides tools
for easy management of a DCOS installation.
for easy management of a DC/OS installation.
Available DCOS commands:
Available DC/OS commands:
auth Authenticate to DCOS cluster
config Manage the DCOS configuration file
help Display help information about DCOS
marathon Deploy and manage applications to DCOS
node Administer and manage DCOS cluster nodes
package Install and manage DCOS software packages
service Manage DCOS services
task Manage DCOS tasks
auth Authenticate to DC/OS cluster
config Manage the DC/OS configuration file
help Display help information about DC/OS
marathon Deploy and manage applications to DC/OS
node Administer and manage DC/OS cluster nodes
package Install and manage DC/OS software packages
service Manage DC/OS services
task Manage DC/OS tasks
Get detailed command description with 'dcos <command> --help'.

2
cli/tests/data/help/help.txt
View File

@ -1,5 +1,5 @@
Description:
Display help information about DCOS.
Display help information about DC/OS.
Usage:
dcos help

4
cli/tests/data/help/marathon.txt
View File

@ -1,5 +1,5 @@
Description:
Deploy and manage applications to DCOS.
Deploy and manage applications to DC/OS.
Usage:
dcos marathon --config-schema
@ -33,7 +33,7 @@ Usage:
Commands:
about
Print info.json for DCOS Marathon.
Print info.json for DC/OS Marathon.
app add
Add an application.
app list

6
cli/tests/data/help/node.txt
View File

@ -1,5 +1,5 @@
Description:
Administer and manage DCOS cluster nodes.
Administer and manage DC/OS cluster nodes.
Usage:
dcos node --help
@ -17,7 +17,7 @@ Commands:
log
Prints the Mesos logs for the leading master node, agent nodes, or both.
ssh
Establish an SSH connection to the master or agent nodes of your DCOS
Establish an SSH connection to the master or agent nodes of your DC/OS
cluster.
Options:
@ -39,7 +39,7 @@ Options:
Deprecated. Please use --leader.
--master-proxy
Proxy the SSH connection through a master node. This can be useful when
accessing DCOS from a separate network. For example, in the default AWS
accessing DC/OS from a separate network. For example, in the default AWS
configuration, the private slaves are unreachable from the public
internet. You can access them using this option, which will first hop
from the publicly available master.

10
cli/tests/data/help/package.txt
View File

@ -1,5 +1,5 @@
Description:
Install and manage DCOS software packages.
Install and manage DC/OS software packages.
Usage:
dcos package --config-schema
@ -31,13 +31,13 @@ Commands:
install
Install a package.
list
Print a list of the installed DCOS packages.
Print a list of the installed DC/OS packages.
search
Search the package repository.
repo add
Add a package repository to DCOS.
Add a package repository to DC/OS.
repo remove
Remove a package repository from DCOS.
Remove a package repository from DC/OS.
repo list
Print the package repository sources. Possible sources include a local
file, HTTPS, and Git.
@ -82,7 +82,7 @@ Options:
Positional Arguments:
<package-name>
Name of the DCOS package in the package repository.
Name of the DC/OS package in the package repository.
<query>
Pattern to use for searching the package repository. You can use
complete or partial values.

8
cli/tests/data/help/service.txt
View File

@ -1,5 +1,5 @@
Description:
Manage DCOS services.
Manage DC/OS services.
Usage:
dcos service --help
@ -31,7 +31,7 @@ Options:
--info
Print a short description of this subcommand.
--json
Print JSON-formatted list of DCOS services.
Print JSON-formatted list of DC/OS services.
--lines=N
Print the last N lines, where 10 is the default.
--ssh-config-file=<path>
@ -44,6 +44,6 @@ Positional Arguments:
<file>
The service log filename for the Mesos sandbox. The default is stdout.
<service>
The DCOS Service name.
The DC/OS Service name.
<service-id>
The DCOS Service ID.
The DC/OS Service ID.

2
cli/tests/data/help/task.txt
View File

@ -1,5 +1,5 @@
Description:
Manage DCOS tasks.
Manage DC/OS tasks.
Usage:
dcos task --help

4
cli/tests/fixtures/package.py vendored
View File

@ -1,5 +1,5 @@
def package_fixture():
""" DCOS package fixture.
""" DC/OS package fixture.
:rtype: dict
"""
@ -30,7 +30,7 @@ def package_fixture():
def search_result_fixture():
""" DCOS package search result fixture.
""" DC/OS package search result fixture.
:rtype: dict
"""

2
cli/tests/integrations/test_auth.py
View File

@ -19,7 +19,7 @@ def env():
def test_info():
stdout = b'Authenticate to DCOS cluster\n'
stdout = b'Authenticate to DC/OS cluster\n'
assert_command(['dcos', 'auth', '--info'],
stdout=stdout)

2
cli/tests/integrations/test_config.py
View File

@ -28,7 +28,7 @@ def test_help():
def test_info():
stdout = b'Manage the DCOS configuration file\n'
stdout = b'Manage the DC/OS configuration file\n'
assert_command(['dcos', 'config', '--info'],
stdout=stdout)

4
cli/tests/integrations/test_dcos.py
View File

@ -31,7 +31,7 @@ def test_log_level_flag():
['dcos', '--log-level=info', 'config', '--info'])
assert returncode == 0
assert stdout == b"Manage the DCOS configuration file\n"
assert stdout == b"Manage the DC/OS configuration file\n"
def test_capital_log_level_flag():
@ -39,7 +39,7 @@ def test_capital_log_level_flag():
['dcos', '--log-level=INFO', 'config', '--info'])
assert returncode == 0
assert stdout == b"Manage the DCOS configuration file\n"
assert stdout == b"Manage the DC/OS configuration file\n"
def test_invalid_log_level_flag():

24
cli/tests/integrations/test_help.py
View File

@ -9,7 +9,7 @@ def test_help():
def test_info():
assert_command(['dcos', 'help', '--info'],
stdout=b'Display help information about DCOS\n')
stdout=b'Display help information about DC/OS\n')
def test_version():
@ -20,20 +20,20 @@ def test_version():
def test_list():
stdout = """\
Command line utility for the Mesosphere Datacenter Operating
System (DCOS). The Mesosphere DCOS is a distributed operating
System (DC/OS). The Mesosphere DC/OS is a distributed operating
system built around Apache Mesos. This utility provides tools
for easy management of a DCOS installation.
for easy management of a DC/OS installation.
Available DCOS commands:
Available DC/OS commands:
\tauth \tAuthenticate to DCOS cluster
\tconfig \tManage the DCOS configuration file
\thelp \tDisplay help information about DCOS
\tmarathon \tDeploy and manage applications to DCOS
\tnode \tAdminister and manage DCOS cluster nodes
\tpackage \tInstall and manage DCOS software packages
\tservice \tManage DCOS services
\ttask \tManage DCOS tasks
\tauth \tAuthenticate to DC/OS cluster
\tconfig \tManage the DC/OS configuration file
\thelp \tDisplay help information about DC/OS
\tmarathon \tDeploy and manage applications to DC/OS
\tnode \tAdminister and manage DC/OS cluster nodes
\tpackage \tInstall and manage DC/OS software packages
\tservice \tManage DC/OS services
\ttask \tManage DC/OS tasks
Get detailed command description with 'dcos <command> --help'.
""".encode('utf-8')

2
cli/tests/integrations/test_marathon.py
View File

@ -30,7 +30,7 @@ def test_version():
def test_info():
assert_command(['dcos', 'marathon', '--info'],
stdout=b'Deploy and manage applications to DCOS\n')
stdout=b'Deploy and manage applications to DC/OS\n')
def test_about():

2
cli/tests/integrations/test_node.py
View File

@ -18,7 +18,7 @@ def test_help():
def test_info():
stdout = b"Administer and manage DCOS cluster nodes\n"
stdout = b"Administer and manage DC/OS cluster nodes\n"
assert_command(['dcos', 'node', '--info'], stdout=stdout)

2
cli/tests/integrations/test_package.py
View File

@ -47,7 +47,7 @@ def test_package():
def test_info():
info = b"Install and manage DCOS software packages\n"
info = b"Install and manage DC/OS software packages\n"
assert_command(['dcos', 'package', '--info'],
stdout=info)

2
cli/tests/integrations/test_service.py
View File

@ -48,7 +48,7 @@ def test_help():
def test_info():
stdout = b"Manage DCOS services\n"
stdout = b"Manage DC/OS services\n"
assert_command(['dcos', 'service', '--info'], stdout=stdout)

2
cli/tests/integrations/test_task.py
View File

@ -49,7 +49,7 @@ def test_help():
def test_info():
stdout = b"Manage DCOS tasks\n"
stdout = b"Manage DC/OS tasks\n"
assert_command(['dcos', 'task', '--info'], stdout=stdout)

2
cli/tests/unit/test_http_auth.py
View File

@ -48,7 +48,7 @@ def test_get_http_auth_not_supported(mock):
http._get_http_auth(mock, url=urlparse(''), auth_scheme='foo')
msg = ("Server responded with an HTTP 'www-authenticate' field of "
"'test', DCOS only supports 'Basic'")
"'test', DC/OS only supports 'Basic'")
assert e.exconly().split(':')[1].strip() == msg

2
dcos/__init__.py
View File

@ -1,4 +1,4 @@
# Version is set for releases by our build system.
# Be extremely careful when modifying.
version = 'SNAPSHOT'
"""DCOS version"""
"""DC/OS version"""

10
dcos/constants.py
View File

@ -1,5 +1,5 @@
DCOS_DIR = ".dcos"
"""DCOS data directory. Can store subcommands and the config file."""
"""DC/OS data directory. Can store subcommands and the config file."""
DCOS_SUBCOMMAND_ENV_SUBDIR = 'env'
"""In a package's directory, this is the cli contents subdirectory."""
@ -9,13 +9,13 @@ DCOS_SUBCOMMAND_SUBDIR = 'subcommands'
relative to the location of the executable."""
DCOS_CONFIG_ENV = 'DCOS_CONFIG'
"""Name of the environment variable pointing to the DCOS config."""
"""Name of the environment variable pointing to the DC/OS config."""
DCOS_LOG_LEVEL_ENV = 'DCOS_LOG_LEVEL'
"""Name of the environment variable for the DCOS log level"""
"""Name of the environment variable for the DC/OS log level"""
DCOS_DEBUG_ENV = 'DCOS_DEBUG'
"""Name of the environment variable to enable DCOS debug messages"""
"""Name of the environment variable to enable DC/OS debug messages"""
DCOS_PAGER_COMMAND_ENV = 'PAGER'
"""Command to use to page long command output (e.g. 'less -R')"""
@ -24,7 +24,7 @@ PATH_ENV = 'PATH'
"""Name of the environment variable pointing to the executable directories."""
DCOS_COMMAND_PREFIX = 'dcos-'
"""Prefix for all the DCOS CLI commands."""
"""Prefix for all the DC/OS CLI commands."""
VALID_LOG_LEVEL_VALUES = ['debug', 'info', 'warning', 'error', 'critical']
"""List of all the supported log level values for the CLIs"""

8
dcos/data/config-schema/core.json
View File

@ -3,14 +3,14 @@
"additionalProperties": false,
"properties": {
"dcos_url": {
"description": "The public master IP of your DCOS installation",
"description": "The public master IP of your DC/OS installation",
"format": "uri",
"title": "DCOS URL",
"title": "DC/OS URL",
"type": "string"
},
"dcos_acs_token": {
"description": "The token generated by authenticating to DCOS with ACS",
"title": "DCOS ACS token",
"description": "The token generated by authenticating to DC/OS with ACS",
"title": "DC/OS ACS token",
"type": "string"
},
"mesos_master_url": {

4
dcos/http.py
View File

@ -353,7 +353,7 @@ def _get_auth_credentials(username, hostname):
def get_auth_scheme(response):
"""Return authentication scheme and realm requested by server for 'Basic'
or 'acsjwt' (DCOS acs auth) or 'oauthjwt' (DCOS acs oauth) type
or 'acsjwt' (DC/OS acs auth) or 'oauthjwt' (DC/OS acs oauth) type
:param response: requests.response
:type response: requests.Response
@ -399,7 +399,7 @@ def _get_http_auth(response, url, auth_scheme):
if 'www-authenticate' in response.headers:
if auth_scheme not in ['basic', 'acsjwt', 'oauthjwt']:
msg = ("Server responded with an HTTP 'www-authenticate' field of "
"'{}', DCOS only supports 'Basic'".format(
"'{}', DC/OS only supports 'Basic'".format(
response.headers['www-authenticate']))
raise DCOSException(msg)

12
dcos/mesos.py
View File

@ -26,7 +26,7 @@ def get_master(dcos_client=None):
class DCOSClient(object):
"""Client for communicating with DCOS"""
"""Client for communicating with DC/OS"""
def __init__(self):
toml_config = config.get_config()
@ -40,11 +40,11 @@ class DCOSClient(object):
self._timeout = config.get_config_val('core.timeout', toml_config)
def get_dcos_url(self, path):
""" Create a DCOS URL
""" Create a DC/OS URL
:param path: the path suffix of the URL
:type path: str
:returns: DCOS URL
:returns: DC/OS URL
:rtype: str
"""
@ -70,7 +70,7 @@ class DCOSClient(object):
:type slave_id: str
:param private_url: The slave's private URL derived from its
pid. Used when we're accessing mesos
directly, rather than through DCOS.
directly, rather than through DC/OS.
:type private_url: str
:param path: the path suffix of the desired URL
:type path: str
@ -102,7 +102,7 @@ class DCOSClient(object):
:type slave_id: str
:param private_url: The slave's private URL derived from its
pid. Used when we're accessing mesos
directly, rather than through DCOS.
directly, rather than through DC/OS.
:type private_url: str
:returns: Mesos' master state json object
:rtype: dict
@ -131,7 +131,7 @@ class DCOSClient(object):
:type path: str
:param private_url: The slave's private URL derived from its
pid. Used when we're accessing mesos
directly, rather than through DCOS.
directly, rather than through DC/OS.
:type private_url: str
:param offset: start byte location, or -1. -1 means read no data, and
is used to fetch the size of the file in the response's

2
dcos/package.py
View File

@ -66,7 +66,7 @@ def uninstall_subcommand(distribution_name):
class InstalledPackage(object):
"""Represents an intalled DCOS package. One of `app` and
"""Represents an intalled DC/OS package. One of `app` and
`subcommand` must be supplied.
:param apps: A dictionary representing a marathon app. Of the

10
pydoc/conf.py
View File

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# DCOS Command Line Interface documentation build configuration file, created by
# DC/OS Command Line Interface documentation build configuration file, created by
# sphinx-quickstart on Sat Jan 31 23:07:01 2015.
#
# This file is execfile()d with the current directory set to its
@ -47,7 +47,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'DCOS Command Line Interface'
project = u'DC/OS Command Line Interface'
copyright = u'2015, Mesosphere, Inc.'
# The version info for the project you're documenting, acts as replacement for
@ -202,7 +202,7 @@ latex_elements = {
latex_documents = [
('index',
'DCOSCommandLineInterface.tex',
u'DCOS Command Line Interface Documentation',
u'DC/OS Command Line Interface Documentation',
u'Mesosphere, Inc.',
'manual'),
]
@ -235,7 +235,7 @@ latex_documents = [
man_pages = [
('index',
'dcoscommandlineinterface',
u'DCOS Command Line Interface Documentation',
u'DC/OS Command Line Interface Documentation',
[u'Mesosphere, Inc.'],
1)
]
@ -251,7 +251,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
('index',
'DCOSCommandLineInterface', u'DCOS Command Line Interface Documentation',
'DCOSCommandLineInterface', u'DC/OS Command Line Interface Documentation',
u'Mesosphere, Inc.',
'DCOSCommandLineInterface', 'One line description of project.',
'Miscellaneous'),

2
pydoc/developer_guide.rst
View File

@ -1,7 +1,7 @@
Developer Guide
===============
This will contain instructions for developers of the DCOS CLI.
This will contain instructions for developers of the DC/OS CLI.
.. toctree::
:maxdepth: 2

2
pydoc/index.rst
View File

@ -1,4 +1,4 @@
Welcome to DCOS Command Line Interface's documentation!
Welcome to DC/OS Command Line Interface's documentation!
=======================================================
.. Figure out a way to import the README.rst

2
pydoc/user_guide.rst
View File

@ -1,4 +1,4 @@
User Guide
==========
This will contain instructions for end users of the DCOS CLI.
This will contain instructions for end users of the DC/OS CLI.

4
win_bin/install/install-dcos-cli.ps1
View File

@ -61,7 +61,7 @@ if (-Not(Get-Command git -errorAction SilentlyContinue))
exit 1
}
echo "Installing DCOS CLI from PyPI..."
echo "Installing DC/OS CLI from PyPI..."
echo ""
if (-Not([System.IO.Path]::IsPathRooted("$installation_path"))) {
@ -133,7 +133,7 @@ switch -regex ($add_path)
default {PromptAddToPath "$installation_path\Scripts"}
}
echo "Finished installing and configuring DCOS CLI."
echo "Finished installing and configuring DC/OS CLI."
echo ""
echo "Run this command to set up your environment and to get started:"
echo "& $ACTIVATE_PATH; dcos help"

4
win_bin/install/legacy/install-legacy-dcos-cli.ps1
View File

@ -61,7 +61,7 @@ if (-Not(Get-Command git -errorAction SilentlyContinue))
exit 1
}
echo "Installing DCOS CLI from PyPI..."
echo "Installing DC/OS CLI from PyPI..."
echo ""
if (-Not([System.IO.Path]::IsPathRooted("$installation_path"))) {
@ -137,7 +137,7 @@ switch -regex ($add_path)
default {PromptAddToPath "$installation_path\Scripts"}
}
echo "Finished installing and configuring DCOS CLI."
echo "Finished installing and configuring DC/OS CLI."
echo ""
echo "Run this command to set up your environment and to get started:"
echo "& $ACTIVATE_PATH; dcos help"