Skip to content

Commit ba648da

Browse files
mikebrowmikebrow
authored
Merge pull request #1 from sudo-bmitch/pr-repo-setup
Initial wg-auth repo setup
2 parents 5390f14 + 6fa4cac commit ba648da

File tree

7 files changed

+151
-2
lines changed

7 files changed

+151
-2
lines changed

‎.github/workflows/linting.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Linting
2+
3+
on:
4+
pull_request:
5+
branches_ignore: []
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
11+
name: Linting
12+
steps:
13+
14+
- name: Checkout
15+
uses: actions/checkout@v3
16+
17+
- name: Render and Lint
18+
run: make lint

‎.markdownlint.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# all lists use a `-`
2+
MD004:
3+
style: dash
4+
5+
# allow tabs in code blocks (for Go)
6+
MD010:
7+
code_blocks: false
8+
9+
# disable line length, prefer one sentence per line for PRs
10+
MD013: false
11+
12+
# emphasis with underscore (`_emphasis_`)
13+
MD049:
14+
style: "underscore"
15+
16+
# bold with asterisk (`**bold**`)
17+
MD050:
18+
style: "asterisk"

‎CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @imjasonh @jcarter3 @mikebrow @rchincha @sudo-bmitch @toddysm

‎GOVERNANCE.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Auth Working Group Governance
2+
3+
This group is subject to the governance documented in the [TOB proposal](https://github.com/opencontainers/tob/blob/main/proposals/wg-auth.md#governance).
4+
5+
## Code of Conduct
6+
7+
Working group members and maintainers shall follow the [OCI code of conduct](https://github.com/opencontainers/.github/blob/master/CODE_OF_CONDUCT.md)
8+
9+
## Discussion
10+
11+
- Discussions take place in the [GitHub repo](https://github.com/opencontainers/wg-auth) and during [weekly meetings](https://github.com/opencontainers/wg-auth/blob/main/README.md#meetings).
12+
- Notes taken during the community meetings are recorded in [this hackmd document](https://hackmd.io/bGIxKAxPROi8KlwZMQioXQ), and later migrated to the [minutes](./minutes) folder via pull request.
13+
14+
## Maintainer Operations
15+
16+
The list of current maintainers shall be recorded in the [CODEOWNERS](https://github.com/opencontainers/wg-auth/blob/main/CODEOWNERS) document.
17+
18+
- Maintainers shall be responsible for overseeing documentation of community decisions, consensus, and resolution of conflicts.
19+
- Maintainers shall provide timely feedback to requests for review and promptly merge approved Pull Requests.
20+
- Maintainers shall operate in good faith and trust in the community and in each other.
21+
- Maintainers shall keep the documentation, issues, and discussion topics as up-to-date as possible.
22+
- In the event a Maintainer cannot perform their duties or have been inactive for a period of time, an interim or permanent replacement shall be nominated from the community.
23+
- Consensus on unblocking inactivity or deadlock must be reached in a community meeting and recorded in the meeting minutes.
24+
- Any member from the community may volunteer to be a maintainer as long as they pledge to follow the OCI code of conduct and perform these duties.
25+
26+
## Conflict Resolution
27+
28+
- Conflicts that cannot be resolved within the group shall be referred to the OCI Technical Oversight Board (TOB) as per [section 5.xv](https://github.com/opencontainers/tob/blob/main/CHARTER.md#5-technical-developer-community) of the TOB Charter.
29+
- Resolution of the conflict shall be documented on this GitHub repository's issues which can be referred to in a pull request.

‎Makefile‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
MARKDOWN_LINT_VER?=v0.8.1
2+
3+
default: lint
4+
5+
.PHONY: lint
6+
lint: lint-md ## Run all linters
7+
8+
.PHONY: lint-md
9+
lint-md: ## Run linting for markdown
10+
docker run --rm -v "$(PWD):/workdir:ro" docker.io/davidanson/markdownlint-cli2:$(MARKDOWN_LINT_VER) \
11+
"**/*.md"
12+
13+
.PHONY: help
14+
help: # Display help
15+
@awk -F ':|##' '/^[^\t].+?:.*?##/ { printf "\033[36m%-30s\033[0m %s\n", $$1, $$NF }' $(MAKEFILE_LIST)

‎README.md‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# wg-auth
2-
OCI Auth WG
1+
# OCI Working Group: Auth
2+
3+
## Mission Statement
4+
5+
Authentication and authorization are a key requirement for registries to control access.
6+
Implementations of this in registries and clients have roughly followed standards set by Docker and have mostly focused on compatibility with specific implementations of registries or clients.
7+
This working group will define a standard to be supported by OCI compatible registries and clients when support for authentication and authorization is required.
8+
9+
## Background
10+
11+
- [TOB Proposal](https://github.com/opencontainers/tob/blob/main/proposals/wg-auth.md)
12+
13+
## Governance
14+
15+
Link to [governance](./GOVERNANCE.md) document.
16+
17+
## Meetings
18+
19+
- WG Meeting: [Tuesdays at 10:00am PT (Pacific Time)](https://zoom.us/j/92128676364) (weekly). [Convert to your timezone](https://dateful.com/convert/pt-pacific-time?t=10am).
20+
- [Meeting notes and Agenda](https://hackmd.io/YyhWh7X_RuCod0i0mGxVLg).
21+
- [Past Meetings](https://github.com/opencontainers/wg-auth/tree/main/minutes).
22+
23+
## Organizers
24+
25+
- Brandon Mitchell (@sudo-bmitch)
26+
- Jason Hall (@imjasonh)
27+
- Jeff Carter (@jcarter3)
28+
- Mike Brown (@mikebrow)
29+
- Ramkumar Chinchani (@rchincha)
30+
- Toddy Mladenov (@toddysm)
31+
32+
## Contact
33+
34+
- Slack: [#wg-auth](https://opencontainers.slack.com/messages/wg-auth)

‎minutes/2023-08-01.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Minutes for 2023-08-01
2+
3+
## Attendees
4+
5+
- Brandon Mitchell
6+
- Jason Hall
7+
- Aviral Takkar
8+
- Jeff Carter
9+
- Sajay Antony
10+
- Josh Dolitsky
11+
- Nathan Anderson
12+
- Victor Lu
13+
- Vincent Batts
14+
15+
## Actionable Agenda Items
16+
17+
- None
18+
19+
## Presentation/Discussion Agenda Items
20+
21+
- Discuss what the participants would like to see out of this group
22+
- Procedural questions
23+
- Where to iterate and file issues etc.
24+
25+
## Notes
26+
27+
- [Repo creation request](https://github.com/opencontainers/tob/issues/127)
28+
- Josh: Jon (who isn't here) once shared this image with me and it changed my life <https://raw.githubusercontent.com/google/go-containerregistry/main/images/credhelper-basic.svg>
29+
- Jason: Consider adding docker authentication docs as a baseline and add to it if thats possibly
30+
- Jason: document the state of the world is the milestone. And really restrain on improving the state of the world?
31+
- Josh: <https://github.com/google/go-containerregistry/blob/ea19b579661d99bc753c92e93730b8aab6ecd31b/pkg/authn/README.md#the-registry>
32+
- Next steps / Action Items:
33+
- New repo creation
34+
- Document the Docker spec as it exists today
35+
- Gather use cases not covered by the existing Docker spec
36+
- Gather IETF/HTTP specs that can be leveraged

0 commit comments

Comments
 (0)