Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Remove GHCR references #503

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 0 additions & 49 deletions .github/workflows/cloudshell-build-push.yaml

This file was deleted.

50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,8 @@ Cloud Shell team respects and enjoys engaging with our customers, please share o
## About this repository

When you connect to Azure Cloud Shell, we start a container hosting a wide variety of tools, and

connect your browser to a shell process running inside that container. This repository contains the
Docker files used to build that container image. It does _not_ contain the code used for the rest of

the Azure Cloud Shell service. The code in this repository may not match exactly to what is running
in the Cloud Shell service at any given time. The service is updated periodically and changes are
gradually rolled out to different regions over time.
Expand Down Expand Up @@ -75,20 +73,16 @@ When building or using the image locally, you don't need to worry about that. Ju
instructions below, and be aware that changes to the base layer will take longer to release than
changes to the tools.

| Layer | Job |
| ---|---|
| Base | Contains large, infrequently changing packages. Changes every 3-4 months. |
| Tools | Contains frequently changing packages. Changes every 2-3 weeks |
| Layer | Job |
|-------|---------------------------------------------------------------------------|
| Base | Contains large, infrequently changing packages. Changes every 3-4 months. |
| Tools | Contains frequently changing packages. Changes every 2-3 weeks |


## Building and Testing the image

### Building the images

> [!NOTE]
> Cloud Shell publishes an image on each update to the master branch. If you would like to use the pre-built image, then
> you can skip this step by downloading the latest [base image layer here](ghcr.io/azure/cloudshell/base:latest)
> and the latest [tools image layer here](ghcr.io/azure/cloudshell/tools:latest). You can find all previously built image layers [here](https://github.com/orgs/Azure/packages?repo_name=CloudShell).

Required software:

- Docker
Expand All @@ -97,13 +91,18 @@ Required software:
Building base.Dockerfile image from the root repository

```bash
docker build -t base_cloudshell -f linux/base.Dockerfile .
docker build \
-t base_cloudshell \
-f linux/base.Dockerfile .
```

Building tools.Dockerfile image

```bash
docker build -t tools_cloudshell --build-arg IMAGE_LOCATION=base_cloudshell -f linux/tools.Dockerfile .
docker build \
-t tools_cloudshell \
--build-arg IMAGE_LOCATION=base_cloudshell \
-f linux/tools.Dockerfile .
```

### Testing the images
Expand All @@ -123,7 +122,10 @@ docker run -it tools_cloudshell /usr/bin/pwsh
Testing the Cloud Shell image:

```bash
docker run --volume /path/to/CloudShell/folder/tests:/tests -it tools_cloudshell /tests/test.sh
docker run \
--volume $(pwd)/tests:/tests \
-it tools_cloudshell \
/tests/test.sh
```

For more information about bind mounts, please see the
Expand All @@ -134,18 +136,18 @@ to pass if you want your changes to be merged.

### Types of issues

| Issue Type | Action |
| ---|---|
| Package is out of date | Create a Pull Request or Issue |
| Add a package to my Cloud Shell | Follow [Cloud Shell package addition](./docs/add-package-into-cloudshell.md) |
| Add a package to everyone's Cloud Shell | Follow [Package Inclusion Guide](./docs/package-inclusion-guide.md) |
| New desired Cloud Shell feature | Create an [Discussion](https://github.com/Azure/CloudShell/discussions) |
| Issue with one of the packages* | Talk to package owner & create a PR on their repo. |
| Issue with how package interacts with Cloud Shell | Create a Pull Request OR GitHub Issue |
| Security bug | See <https://www.microsoft.com/en-us/msrc/faqs-report-an-issue> |
| Issue Type | Action |
|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| Package is out of date | Create a Pull Request or Issue |
| Add a package to my Cloud Shell | Follow [Cloud Shell package addition](./docs/add-package-into-cloudshell.md) |
| Add a package to everyone's Cloud Shell | Follow [Package Inclusion Guide](./docs/package-inclusion-guide.md) |
| New desired Cloud Shell feature | Create an [Discussion](https://github.com/Azure/CloudShell/discussions) |
| Issue with one of the packages* | Talk to package owner & create a PR on their repo. |
| Issue with how package interacts with Cloud Shell | Create a Pull Request OR GitHub Issue |
| Security bug | See <https://www.microsoft.com/en-us/msrc/faqs-report-an-issue> |
| Issue with Cloud Shell in Azure Portal (can't log in, for example) | Open a [support ticket](https://learn.microsoft.com/azure/active-directory/fundamentals/how-to-get-support) |

<sup>*</sup> For example, if you have an issue within Azure CLI, don't open up an issue in the Cloud Shell
For example, if you have an issue within Azure CLI, don't open up an issue in the Cloud Shell
repo, open an issue within the Azure CLI repo.

- [Azure PowerShell issues](https://github.com/Azure/azure-powershell/issues)
Expand Down
Loading