Skip to content

Commit a3932af

Browse files
mysteriouspantsmysteriouspants
authored
Merge pull request #93 from amazonlinux/docs-update
2 parents cc7a187 + 587c15d commit a3932af

File tree

9 files changed

+157
-627
lines changed

9 files changed

+157
-627
lines changed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Amazon Linux 2023 Public Support
4+
url: https://github.com/amazonlinux/amazon-linux-2023
5+
about: General public support for Amazon Linux 2023

‎.github/ISSUE_TEMPLATE/package.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Package Request
2+
description: Request a new or upgrade to an existing package.
3+
title: "[Package] "
4+
labels: ["package", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Amazon Linux is composed of packages. You can request that we
10+
add or upgrade a package that is important to you.
11+
- type: dropdown
12+
id: product
13+
attributes:
14+
label: Product
15+
description: Which Amazon Linux product do you want to know more about?
16+
options:
17+
- Amazon Linux 1
18+
- Amazon Linux 2
19+
- Amazon Linux 2023
20+
validations:
21+
required: true
22+
- type: input
23+
id: package
24+
attributes:
25+
label: Package
26+
description: What package and version are you interested in?
27+
placeholder: libfoo-2.0
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: justification
32+
attributes:
33+
label: Why do you need this package?
34+
validations:
35+
required: true
36+
- type: markdown
37+
attributes:
38+
value: |
39+
This bug tracker is monitored by the subteam of Amazon Linux
40+
responsible for building images from packages. You may also
41+
consider asking in a more OS-specific issue tracker, or
42+
contacting AWS Support. We cannot discuss everything publicly,
43+
and may have to refer your question to other teams. Urgent
44+
issues must go through AWS Support.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Question
2+
description: General questions, not specifically bugs
3+
title: "[Question]: "
4+
labels: ["question", "triage"]
5+
body:
6+
- type: dropdown
7+
id: product
8+
attributes:
9+
label: Product
10+
description: Which Amazon Linux product do you want to know more about?
11+
options:
12+
- Amazon Linux 1
13+
- Amazon Linux 2
14+
- Amazon Linux 2023
15+
- Not Specific / Don't Know
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: question
20+
attributes:
21+
label: What is your question?
22+
validations:
23+
required: true
24+
- type: markdown
25+
attributes:
26+
value: |
27+
This bug tracker is monitored by the subteam of Amazon Linux
28+
responsible for building images from packages. You may also
29+
consider asking in a more OS-specific issue tracker, or
30+
contacting AWS Support. We cannot discuss everything publicly,
31+
and may have to refer your question to other teams. Urgent
32+
issues must go through AWS Support.

‎.github/ISSUE_TEMPLATE/security.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Security
2+
description: Security-related questions
3+
title: "[Security]: "
4+
labels: ["security", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Responsibly disclose security issues to AWS Support.
10+
We will never discuss private customer information, embargoed
11+
security issues, or patching timelines here. To see all issues
12+
we are currently tracking, see
13+
[ALAS](https://alas.aws.amazon.com/). If you're not sure, please
14+
contact AWS Support.
15+
- type: dropdown
16+
id: product
17+
attributes:
18+
label: Product
19+
description: Which Amazon Linux product do you want to know more about?
20+
options:
21+
- Amazon Linux 1
22+
- Amazon Linux 2
23+
- Amazon Linux 2023
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: question
28+
attributes:
29+
label: What is your question?
30+
validations:
31+
required: true
32+
- type: markdown
33+
attributes:
34+
value: |
35+
This bug tracker is monitored by the subteam of Amazon Linux
36+
responsible for building images from packages. You may also
37+
consider asking in a more OS-specific issue tracker, or
38+
contacting AWS Support. We cannot discuss everything publicly,
39+
and may have to refer your question to other teams. Urgent
40+
issues must go through AWS Support.

‎README.md‎

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,42 @@
11
# Amazon Linux container images
22

3-
This repository contains the base container images for Amazon Linux on [Docker Hub](https://hub.docker.com/_/amazonlinux/) and [Amazon Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/amazon_linux_container_image.html).
3+
This repository contains the base container images for Amazon Linux on
4+
[Docker Hub][dockerhub] and [Amazon Elastic Container Registry][ecr].
45

5-
This is more of an *artifact store* than a Git repository, for reasons explained later. Please note that **branches other than `master` are regularly force-pushed, and content may disappear without warning**. For more reliable sources of Amazon Linux container images, use the [Amazon Linux on-premises image download site](https://cdn.amazonlinux.com/os-images/latest/), Docker Hub, and Amazon ECR.
6+
This is more of an *artifact store* than a Git repository, for reasons
7+
explained later. Please note that **branches other than `master` are
8+
regularly force-pushed, and content may disappear without warning**. For
9+
more reliable sources of Amazon Linux container images, use the
10+
[Amazon Linux on-premises image download site][onprem], Docker Hub, or
11+
Amazon ECR.
612

713
## What we're doing here
814

9-
The [Docker Official Images program](https://docs.docker.com/docker-hub/official_images/) produces the top-level images available on Docker Hub, including the base OS images that serve as a starting point for most Docker users.
10-
11-
The images are maintained in the open. Image generation starts from a file in [docker-library/official-images.git](https://github.com/docker-library/official-images) named [library/amazonlinux](https://github.com/docker-library/official-images/blob/master/library/amazonlinux). This file is machine-readable and connects image tags to a Git repository and commit.
12-
13-
During image build, the build system clones the referenced Git repository at a given commit and runs `docker build` in that directory. For application images, this usually involves downloading and installing software. For base OS images, this means adding the contents of a tarball as a single layer:
14-
15-
```
16-
FROM scratch
17-
ADD amzn2-container-raw-2.0.yyyymmdd-x86_64.tar.xz /
18-
CMD ["/bin/bash"]
19-
```
20-
21-
Committed alongside the Dockerfile is the tarball, which balloons the repository size. Thus, we force-push branches that contain the tarballs.
22-
23-
Although we force-push the files away, the older versions of our images remain present on Docker Hub and Amazon ECR.
24-
25-
We use [a script to generate the other branches of this repository](update-script/update.sh).
15+
The [Docker Official Images program][doi] produces the top-level images
16+
available on Docker Hub, including the base OS images that serve as a
17+
starting point for most Docker users.
18+
19+
The images are maintained in the open. Image generation starts from a
20+
file in [docker-library/official-images.git][doi-git] named
21+
[library/amazonlinux][doi-git-al]. This file is machine-readable and
22+
connects image tags to a Git repository and commit.
23+
24+
During image build, the build system clones the referenced Git
25+
repository at a given commit and runs `docker build` in that directory.
26+
For application images, this usually involves downloading and installing
27+
software. For base OS images, this means adding the contents of a
28+
tarball as a single layer.
29+
30+
## Distribution SLAs
31+
32+
Amazon Linux is able to update our first-party sources (ECR) same-day as
33+
the associated AMI release. To reduce the operational load on the Docker
34+
Official Images program, we batch our OS releases and submit them
35+
weekly.
36+
37+
[dockerhub]: https://hub.docker.com/_/amazonlinux/
38+
[ecr]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/amazon_linux_container_image.html
39+
[onprem]: https://cdn.amazonlinux.com/os-images/latest/
40+
[doi]: https://docs.docker.com/docker-hub/official_images/
41+
[doi-git]: https://github.com/docker-library/official-images
42+
[doi-git-al]: https://github.com/docker-library/official-images/blob/master/library/amazonlinux

‎update-script/LICENSE‎

Lines changed: 0 additions & 202 deletions
This file was deleted.

‎update-script/NOTICE‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)