AWS elasticbeanstalk documentation change
Summary
Restructured EB CLI documentation to focus on installation methods (setup script, manual pip install, virtualenv, homebrew). Added detailed installation steps, removed older CLI version references, updated AWS CLI comparison with new commands, and emphasized recommended installation practices.
Security assessment
Changes focus on installation procedures, documentation structure, and command examples without addressing security vulnerabilities or introducing security features. No evidence of CVE fixes, vulnerability disclosures, or security policy changes. The update to Amazon Linux 2023 in examples reflects version updates rather than security patches.
Diff
diff --git a/elasticbeanstalk/latest/dg/eb-cli3.md b/elasticbeanstalk/latest/dg/eb-cli3.md index 9826e0115..b11a3bca2 100644 --- a//elasticbeanstalk/latest/dg/eb-cli3.md +++ b//elasticbeanstalk/latest/dg/eb-cli3.md @@ -5 +5 @@ -# Using the Elastic Beanstalk command line interface (EB CLI) +Install EB CLIManual installationInstall in virtualenvInstall the EB CLI with homebrew @@ -7 +7 @@ -This topic explains the EB CLI, including installation, configuration, and how to use it to mange your Elastic Beanstalk environments. +# Setting up the EB command line interface (EB CLI) to manage Elastic Beanstalk @@ -9 +9 @@ This topic explains the EB CLI, including installation, configuration, and how t -The EB CLI is a command line interface for AWS Elastic Beanstalk that provides interactive commands that simplify creating, updating and monitoring environments from a local repository. Use the EB CLI as part of your everyday development and testing cycle as an alternative to the Elastic Beanstalk console. +The EB CLI is a command line interface which provides interactive commands to create, update, and monitor environments in AWS Elastic Beanstalk. The EB CLI open-source project is on Github: `[aws/aws-elastic-beanstalk-cli](https://github.com/aws/aws-elastic-beanstalk-cli)` @@ -11 +11 @@ The EB CLI is a command line interface for AWS Elastic Beanstalk that provides i -###### Note +After you install the EB CLI and configure a project directory, you can create environments with a single command: @@ -13 +12,0 @@ The EB CLI is a command line interface for AWS Elastic Beanstalk that provides i -The current version of the EB CLI has a different base set of commands than versions prior to version 3.0. If you are using an older version, see [Migrating to EB CLI 3 and CodeCommit](./eb-cli.html#eb-cli2-migrating) for migration information. @@ -15 +14 @@ The current version of the EB CLI has a different base set of commands than vers -After you [install the EB CLI](./eb-cli3-install.html) and configure a project directory, you can create environments with a single command: + $ eb create <my-beanstalk-environment> @@ -16,0 +16 @@ After you [install the EB CLI](./eb-cli3-install.html) and configure a project d +We recommend installing with the setup script, learn how in Install EB CLI with setup script (recommended). @@ -18 +18 @@ After you [install the EB CLI](./eb-cli3-install.html) and configure a project d - ~/my-app$ eb create my-env +The AWS CLI provides direct access to low-level Elastic Beanstalk APIs. Although powerful, it is also verbose and less preferred over the EB CLI. For example, creating an environment with the AWS CLI requires the following series of commands: @@ -20 +19,0 @@ After you [install the EB CLI](./eb-cli3-install.html) and configure a project d -The source code for the EB CLI is an open-source project. It resides in the `[aws/aws-elastic-beanstalk-cli](https://github.com/aws/aws-elastic-beanstalk-cli)` GitHub repository. You can participate by reporting issues, making suggestions, and submitting pull requests. We value your contributions! For an environment where you only intend to use the EB CLI as is, we recommend that you install it using one of the EB CLI setup scripts, as detailed in [Install the EB CLI using setup scripts](./eb-cli3-install.html#eb-cli3-install.scripts). @@ -22 +21,12 @@ The source code for the EB CLI is an open-source project. It resides in the `[aw -Previously, Elastic Beanstalk supported a separate CLI that provided direct access to API operations called the [Elastic Beanstalk API CLI](./using-api-cli.html). This has been replaced with the [AWS CLI](./chapter-devenv.html#devenv-awscli), which provides the same functionality but for all AWS services' APIs. + $ aws elasticbeanstalk check-dns-availability \ + --cname-prefix my-cname + $ aws elasticbeanstalk create-application-version \ + --application-name my-application \ + --version-label v1 \ + --source-bundle S3Bucket=amzn-s3-demo-bucket,S3Key=php-proxy-sample.zip + $ aws elasticbeanstalk create-environment \ + --cname-prefix my-cname \ + --application-name my-app \ + --version-label v1 \ + --environment-name my-env \ + --solution-stack-name "64bit Amazon Linux 2023 v4.5.0 running Ruby 3.4" @@ -24 +34 @@ Previously, Elastic Beanstalk supported a separate CLI that provided direct acce -With the AWS CLI you have direct access to the Elastic Beanstalk API. The AWS CLI is great for scripting, but is not as easy to use from the command line because of the number of commands that you need to run and the number of parameters on each command. For example, creating an environment requires a series of commands: +## Install EB CLI with setup script (recommended) @@ -25,0 +36 @@ With the AWS CLI you have direct access to the Elastic Beanstalk API. The AWS CL +###### We recommend the installer script @@ -27,3 +38 @@ With the AWS CLI you have direct access to the Elastic Beanstalk API. The AWS CL - ~$ aws elasticbeanstalk check-dns-availability --cname-prefix my-cname - ~$ aws elasticbeanstalk create-application-version --application-name my-application --version-label v1 --source-bundle S3Bucket=amzn-s3-demo-bucket,S3Key=php-proxy-sample.zip - ~$ aws elasticbeanstalk create-environment --cname-prefix my-cname --application-name my-app --version-label v1 --environment-name my-env --solution-stack-name "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)" +We recommend using the installer script to set up the EB CLI and its dependencies and prevent potential conflicts with other Python packages. @@ -31 +40 @@ With the AWS CLI you have direct access to the Elastic Beanstalk API. The AWS CL -For information about installing the EB CLI, configuring a repository, and working with environments, see the following topics. +Pre-requisites: Git, Python, and [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) @@ -33 +42 @@ For information about installing the EB CLI, configuring a repository, and worki -###### Topics +###### To download and use the installer script @@ -35 +44 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Install the Elastic Beanstalk Command Line Interface](./eb-cli3-install.html) + 1. Clone the repository. @@ -37 +46 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Configure the EB CLI](./eb-cli3-configuration.html) + git clone https://github.com/aws/aws-elastic-beanstalk-cli-setup.git @@ -39 +48 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Managing Elastic Beanstalk environments with the EB CLI](./eb-cli3-getting-started.html) + 2. Install or upgrade the EB CLI. @@ -41 +50 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Using the EB CLI with AWS CodeBuild](./eb-cli-codebuild.html) +**macOS / Linux** in Bash or Zsh @@ -43 +52 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Using the EB CLI with Git](./eb3-cli-git.html) + python ./aws-elastic-beanstalk-cli-setup/scripts/ebcli_installer.py @@ -45 +54 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Using the EB CLI with AWS CodeCommit](./eb-cli-codecommit.html) +**Windows** in PowerShell or Command window @@ -47 +56 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Using the EB CLI to monitor environment health](./health-enhanced-ebcli.html) + python .\aws-elastic-beanstalk-cli-setup\scripts\ebcli_installer.py @@ -49 +58 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Managing multiple Elastic Beanstalk environments as a group with the EB CLI](./ebcli-compose.html) + 3. Verify that the EB CLI is installed correctly. @@ -51 +60,2 @@ For information about installing the EB CLI, configuring a repository, and worki - * [Troubleshooting issues with the EB CLI](./eb-cli-troubleshooting.html) + $ eb --version + EB CLI 3.21.0 (Python 3.12) @@ -53 +63,163 @@ For information about installing the EB CLI, configuring a repository, and worki - * [EB CLI command reference](./eb3-cmd-commands.html) + + + +For complete installation instructions, see the [`aws/aws-elastic-beanstalk-cli-setup`](https://github.com/aws/aws-elastic-beanstalk-cli-setup) repository on GitHub. + +## Manually install the EB CLI + +You can install the EB CLI on Linux, macOS, and Windows with the `pip` package manager for Python which provides installation, upgrade, and removal of Python packages and their dependencies. + +###### We recommend the installer script + +We recommend using the Install EB CLI to set up the EB CLI and prevent dependency conflicts. + +**Prerequisite** \- You must have a supported version of Python installed. You can download it from the [Python downloads](https://www.python.org/downloads/) page on the Python website. + +###### To install the EB CLI (manually) + + 1. Run the following command. + + $ pip install awsebcli --upgrade --user + +The `--upgrade` option tells `pip` to upgrade any requirements that are already installed. The `--user` option tells `pip` to install the program to a subdirectory of your user directory to avoid modifying libraries that your operating system uses. + +###### Troubleshooting issues + +If you encounter issues when you try to install the EB CLI with `pip`, you can install the EB CLI in a virtual environment to isolate the tool and its dependencies, or use a different version of Python than you normally do. + + 2. Add the path to the executable file to your `PATH` variable: + + * On Linux and macOS: + +**Linux** – `~/.local/bin` + +**macOS** – `~/Library/Python/`3.12`/bin` + +To modify your `PATH` variable (Linux, Unix, or macOS ): + + 1. Find your shell's profile script in your user folder. If you are not sure which shell you have, run `echo $SHELL`. + + $ ls -a ~ + . .. .bash_logout .bash_profile .bashrc Desktop Documents Downloads + + * **Bash** – `.bash_profile`, `.profile`, or `.bash_login`. + + * **Zsh** – `.zshrc` + + * **Tcsh** – `.tcshrc`, `.cshrc` or `.login`. + + 2. Add an export command to your profile script. The following example adds the path represented by `LOCAL_PATH` to the current `PATH` variable. + + export PATH=LOCAL_PATH:$PATH + + 3. Load the profile script described in the first step into your current session. The following example loads the profile script represented by `PROFILE_SCRIPT`. + + $ source ~/PROFILE_SCRIPT + + * On Windows: + +**Python 3.12** – `%USERPROFILE%\AppData\Roaming\Python\Python312\Scripts` + +**Python earlier versions** – `%USERPROFILE%\AppData\Roaming\Python\Scripts` + +To modify your `PATH` variable (Windows): + + 1. Press the Windows key, and then enter `environment variables`. + + 2. Choose **Edit environment variables for your account**. + + 3. Choose **PATH** , and then choose **Edit**. + + 4. Add paths to the **Variable value** field, separated by semicolons. For example: ``C:\item1\path``;`C:\item2\path``` + + 5. Choose **OK** twice to apply the new settings. + + 6. Close any running Command Prompt windows, and then reopen a Command Prompt window. + + 3. Verify that the EB CLI installed correctly by running **eb \--version**. + + $ eb --version + EB CLI 3.21.0 (Python 3.12) + + + + +The EB CLI is updated regularly to add functionality that supports [the latest Elastic Beanstalk features](https://docs.aws.amazon.com/elasticbeanstalk/latest/relnotes/). To update to the latest version of the EB CLI, run the installation command again. + + + $ pip install awsebcli --upgrade --user + +If you need to uninstall the EB CLI, use `pip uninstall`. + + + $ pip uninstall awsebcli + +## Install the EB CLI in a virtual environment + +You can avoid version requirement conflicts with other `pip` packages by installing the EB CLI in a virtual environment. + +###### To install the EB CLI in a virtual environment + + 1. First, install `virtualenv` with `pip`. + + $ pip install --user virtualenv + + 2. Create a virtual environment. + + $ virtualenv ~/eb-ve + +To use a Python executable other than the default, use the `-p` option. + + $ virtualenv -p /usr/bin/python3.12 ~/eb-ve +