Skip to content

Commit

Permalink
editorial changes to Linux pages (#3505)
Browse files Browse the repository at this point in the history 
* editorial revisions to script.md

* editorial changes

* editorial changes

* Update docs-ref-conceptual/includes/cli-install-linux-dnf.md

Co-authored-by: Hang <[email protected]>

---------

Co-authored-by: Delora Bradish <[email protected]>
Co-authored-by: Hang <[email protected]>
  • Loading branch information
@ChaseCrum @dbradish-microsoft @bebound
3 people authored Feb 17, 2023
1 parent 2c0ed57 commit a16f92f
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 32 deletions.
21 changes: 11 additions & 10 deletions docs-ref-conceptual/includes/cli-install-linux-apt.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The `apt` package manager contains an x86_64 package for the Azure CLI that has
## Installation Options

There are two options to install the Azure CLI on your system. First, you may execute a single command that will download an install script and run the install commands for you. Or if you prefer, you can execute the install commands yourself in a step-by-step process. Both methods are provided below.
There are two options to install the Azure CLI on your system. You can download an install script that will run the install commands for you, or you can execute the install commands yourself in a step-by-step process if you prefer. Both methods are provided below.

## Option 1: Install with one command

Expand Down Expand Up @@ -59,7 +59,7 @@ If you prefer a step-by-step installation process, complete the following steps
sudo chmod go+r /etc/apt/keyrings/microsoft.gpg
```

3. <div id="set-release"/>Add the Azure CLI software repository:
3. Add the Azure CLI software repository:

```bash
AZ_REPO=$(lsb_release -cs)
Expand All @@ -74,9 +74,9 @@ If you prefer a step-by-step installation process, complete the following steps
sudo apt-get install azure-cli
```

## Install specific version
## Installing a specific version

You must first configure `azure-cli` repository information as shown above. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md).
Configure the `azure-cli` repository information as shown above. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md).

1. To view available versions with command:

Expand All @@ -100,14 +100,13 @@ If you installed `azure-cli` on `Focal` without adding the Azure CLI software re

### lsb_release does not return the correct base distribution version

Some Ubuntu- or Debian-derived distributions such as Linux Mint may not return the correct version name from `lsb_release`. This value is used in the install process to
determine the package to install. If you know the code name of the Ubuntu or Debian version your distribution is derived from, you can set the `AZ_REPO` value manually when
Some Ubuntu or other Debian-derived distributions (such as Linux Mint) may not return the correct version name from `lsb_release`. This value is used in the install process to
determine the package to install. If you know the code name of the Ubuntu or Debian version that your distribution is derived from, you can set the `AZ_REPO` value manually when
[adding the repository](#set-release). Otherwise, look up information for your distribution on how to determine the base distribution code name and set `AZ_REPO` to the correct value.

### No package for your distribution

Sometimes it may be a while after a distribution is released before there's an Azure CLI package available for it. The Azure CLI designed to be resilient with regards to future
versions of dependencies and rely on as few of them as possible. If there's no package available for your base distribution, try a package for an earlier distribution.
Sometimes, an updated Azure CLI package isn't immediately available following a distribution version release. The Azure CLI is designed to be resilient with regards to future versions of dependencies and rely on as few of them as possible. If there's no package available for your base distribution, try a package for an earlier distribution.

To do this, set the value of `AZ_REPO` manually when [adding the repository](#set-release). For Ubuntu distributions, use the latest `jammy` repository:

Expand All @@ -121,7 +120,9 @@ For Debian distributions, use the latest `bullseye` repository:
AZ_REPO="bullseye"
```

Distributions released before Ubuntu Bionic and Debian Buster are not supported.
> [!IMPORTANT]
>
> Distributions released before Ubuntu Bionic and Debian Buster are not supported.

### Elementary OS (EOS) fails to install the Azure CLI

Expand Down Expand Up @@ -200,7 +201,7 @@ You can also use `apt-get upgrade` to update the CLI package.
sudo rm /etc/apt/sources.list.d/azure-cli.list
```
3. If you use no other packages from Microsoft, remove the signing key:
3. If you are not using other packages from Microsoft, remove the signing key:
```bash
sudo rm /etc/apt/trusted.gpg.d/microsoft.gpg
Expand Down
24 changes: 13 additions & 11 deletions docs-ref-conceptual/includes/cli-install-linux-dnf.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,17 @@ ms.custom: devx-track-azurecli
For Linux distributions with `dnf` such as RHEL 8/9 or CentOS Stream 8/9, there are RPM packages for Azure CLI.

> [!WARNING]
> Starting from Azure CLI 2.39.0 (released on 08/02/2022), no RPM packages will be released for RHEL 7 and CentOS 7. You may continue to use historical versions of Azure CLI on these systems, but there will be no updates or bugfixes. Consider upgrading to newer versions of RHEL or CentOS to use the latest Azure CLI.
> Starting from Azure CLI 2.39.0 (released on 08/02/2022), no RPM packages will be released for RHEL 7 and CentOS 7. You may continue to use historical versions of Azure CLI on these systems, but there will be no further updates or bug fixes from Microsoft for those versions.
>
> Azure CLI and the Linux [Install script](https://learn.microsoft.com/cli/azure/install-azure-cli-linux?pivots=script) will continue to be developed and supported by Microsoft. Packages provided by Red Hat and CentOS repositories are maintained and supported by their respective distributions.
[!INCLUDE [current-version](current-version.md)]

[!INCLUDE [rpm-warning](rpm-warning.md)]

> [!NOTE]
>
> Use `yum` package manager if you are using Linux systems that don't support `dnf` package manager.
> Use the `yum` package manager if you are using Linux systems that does not support the `dnf` package manager.
## Install

Expand Down Expand Up @@ -59,7 +61,7 @@ For Linux distributions with `dnf` such as RHEL 8/9 or CentOS Stream 8/9, there
sudo dnf install azure-cli
```

## Install specific version
## Installing a specific version

You must first configure `azure-cli` repository information as shown above. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md).

Expand All @@ -69,7 +71,7 @@ You must first configure `azure-cli` repository information as shown above. Avai
dnf list --showduplicates azure-cli
```

2. To install specific version:
2. To install a specific version:

```bash
sudo dnf install azure-cli-<version>-1.el7
Expand All @@ -81,17 +83,17 @@ Here are some common problems seen when installing with `dnf`. If you experience

### Install on RHEL 7.6 or other systems without Python 3

If you can, please upgrade your system to a version with official support for `python 3.6+` package. Otherwise, you need to first install a `python3` package then install Azure CLI without dependency.
If you are able, upgrade your system to a version with official support for `python 3.6+` package. Otherwise, you need to first install a `python3` package then install Azure CLI without dependency.

You can use the following one command to install Azure CLI with `python 3.6` built from source:
You can use the following command to download and install the Azure CLI install script with `python 3.6` built from source:

```bash
curl -sL https://azurecliprod.blob.core.windows.net/rhel7_6_install.sh | sudo bash
```

You can also do it step by step:

First, Azure CLI requires `SSL 1.1+` and you need to build `openssl 1.1` from source before building `python3`:
First, Azure CLI requires `SSL 1.1+` and you will need to build `openssl 1.1` from source before building `python3`:

```bash
sudo dnf install gcc gcc-c++ make ncurses patch wget tar zlib zlib-devel -y
Expand Down Expand Up @@ -121,18 +123,18 @@ make
sudo make install
```

Finally, follow step 1 and 2 of the [install instruction](#install) to add Azure CLI repository. You can now download the package and install it without dependency.
Finally, follow steps 1 and 2 of the [install instruction](#install) to add the Azure CLI repository. You can now download the package and install it without dependency.

> [!NOTE]
>
> In case you don't have the dnf download plugin installed, you will encounter command not found error on executing the below code. Use `dnf install 'dnf-command(download)'` to install the dnf download plugin.
> If the dnf download plugin isn't already installed, you will encounter a `command not found` error when executing the code below. Use `dnf install 'dnf-command(download)'` to install the dnf download plugin.
```bash
sudo dnf download azure-cli
sudo rpm -ivh --nodeps azure-cli-*.rpm
```

As an alternative, you can also install Python 3 through some [additional repo](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/). Following this way, if you have set up `python3` but are still getting an error `python3: command not found` when trying to run the cli, you need to add it to your path.
As an alternative, you can also install Python 3 using an [additional repo](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/). Use this method, if you have set up `python3` but are still getting the error `python3: command not found`. Make sure it has been include it in your path.

```bash
scl enable rh-python36 bash
Expand All @@ -153,7 +155,7 @@ proxy_username=[username] # Only required for basic auth
proxy_password=[password] # Only required for basic auth
```

In order to get the Microsoft signing key and get the package from our repository, your proxy needs to
In order to get the Microsoft signing key and the package from our repository, your proxy needs to
allow HTTPS connections to the following address:

* `https://packages.microsoft.com`
Expand Down
18 changes: 8 additions & 10 deletions docs-ref-conceptual/includes/cli-install-linux-script.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,18 @@ The CLI requires the following software:

> [!IMPORTANT]
>
> The CLI has dropped support for Python 2.7 since version `2.1.0`. New versions no longer
> guarantee to run with Python 2.7 correctly.
> The Azure CLI has dropped support for Python 2.7 since version `2.1.0`. Newer versions may not
> run correctly using Python 2.7.
## Install or update

Both installing and updating the CLI requires re-running the install script. Install the CLI by running `curl`.
Both installing and updating the Azure CLI requires re-running the install script.

```bash
curl -L https://aka.ms/InstallAzureCli | bash
```

The script can also be downloaded and run locally. You may have to restart your shell in order for changes to take effect.
The script can also be downloaded and run locally. You may have to restart your shell in order for the changes to take effect.

## Troubleshooting

Expand All @@ -52,19 +52,17 @@ curl https://azurecliprod.blob.core.windows.net/install | bash

### `az` command not found

If you can't run the command after installation and using `bash` or `zsh`, clear your shell's command hash cache. Run
If you can't run the command after installation using `bash` or `zsh`, try clearing your shell's command hash cache and check if the problem is resolved.

```bash
hash -r
```

and check if the problem is resolved.

The issue can also occur if you didn't restart your shell after installation. Make sure that the location of the `az` command is in your `$PATH`. The location
of the `az` command is

```bash
<install path>/bin
```
<install path>/bin
```

### Proxy blocks connection
Expand All @@ -85,7 +83,7 @@ following addresses:

[!INCLUDE [uninstall-boilerplate.md](uninstall-boilerplate.md)]

Uninstall the CLI by directly deleting the files from the location chosen at the time of installation. The default install location is `$HOME`.
Uninstall the CLI by directly deleting the files from the location chosen at the time of installation. The default install location is the user's home directory ($HOME).

1. Remove the installed CLI files.

Expand Down
4 changes: 3 additions & 1 deletion docs-ref-conceptual/includes/rpm-warning.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ ms.topic: include
> replacement `python3` package.
>
> Be aware that Python 2 has reached end of life (EOL) on January 1, 2020, and will no longer receive
> updates. Azure CLI has dropped support for Python 2.7 since version `2.1.0`. New versions are no longer guaranteed to run with Python 2.7 correctly.
> updates. Azure CLI has dropped support for Python 2.7 since version `2.1.0`. Newer versions may not
> run correctly using Python 2.7.
>

0 comments on commit a16f92f

Please sign in to comment.