Commit Graph

30 Commits

Author SHA1 Message Date
J Logan f3b33ffc45 Cleans up option groups, container subcommand help. (#647)
- Part of #515.
- Add titles to option groups for container subcommands.
- Order option groups and container subcommand options alphabetically.
- Use `container-id` and `container-ids` consistently as argument names.
- Shorten long valueNames to avoid option column overflow in help output
where possible.
- Replace customShort and customLong with short, long, and shortAndLong
where possible.
- Always place global options and arguments after alphabetized
command-specific options.
- Rename RunCommand to ContainerRun and relocate it.
- Rename Executable to ContainerCLI.

## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [x] Breaking change (if you're depending on `RunCommand`, renamed).
- [ ] Documentation update

## Motivation and Context
See #385.

## Testing
- [ ] Tested locally
- [ ] Added/updated tests
- [ ] Added/updated docs
2025-09-22 16:36:07 -07:00
J Logan 06eab455c8 Clarify memory units in help and documentation. (#657)
Closes #519.

## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [ ] Breaking change
- [x] Documentation update

## Motivation and Context
Clarifies memory units.

## Testing
- [x] Tested locally
- [x] Added/updated tests
- [x] Added/updated docs
2025-09-22 11:05:06 -07:00
J Logan 449f1d23df Replace scattered defaults subcommands with system property. (#604)
Common subcommands for all defaults.

- Closes #384.
- Replaces `registry default` and `system dns default` subcommands with
`system property`.
- Users can use `system property ls` to see details about each supported
default value.
- `system property set` implements reasonable validation for all
properties.
- NOTE: Probing of the registry for `registry default set` was removed,
which means users will find out about a botched setting when pulling or
pushing.
- Updates docs.

## Type of Change
- [ ] Bug fix
- [x] New feature  
- [x] Breaking change
- [x] Documentation update

## Motivation and Context
See #384.

## Testing
- [x] Tested locally
- [x] Added/updated tests
- [x] Added/updated docs
2025-09-16 13:37:55 -07:00
J Logan a54be363f7 Add --labels for networks. (#600)
- Closes #557.
- Breaking change: removes `.upToNextOption` for labels on volumes as
this is not what is done for containers, and it forces the argument to
precede the options if a label is supplied, which is non-intuitive.

## Type of Change
- [ ] Bug fix
- [x] New feature  
- [x] Breaking change
- [x] Documentation update

## Motivation and Context
Consistent features and UX across managed resources.

## Testing
- [x] Tested locally
- [x] Added/updated tests
- [x] Added/updated docs
2025-09-15 11:27:51 -07:00
J Logan 6da5ecf838 Remove images alias for image subcommand. (#597)
- Closes #596.

## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [x] Breaking change
- [ ] Documentation update

## Motivation and Context
- Part of UX audit #385.
- All other resource subcommands are singular and have no plural alias.
- `container image` corresponds to `docker image`; `container images`
does not.

## Testing
- [x] Tested locally
- [x] Added/updated tests
- [x] Added/updated docs
2025-09-10 10:06:48 -07:00
Sidhartha Mani e42fe80aa0 Create command-reference.md (#445)
Fixes https://github.com/apple/container/issues/375
2025-08-29 10:23:45 -07:00
J Logan 049adc96ea Adds how-to section for --ssh. (#503) 2025-08-15 15:37:58 -07:00
Danny Canter 3fcf647c7b Add virtualization support for containers (#377) 2025-07-30 11:14:41 -07:00
J Logan eea8cb6709 Adds --publish flag for forwarding traffic to container ports. (#352) 2025-07-23 00:28:41 -07:00
Steven Behnke 0327859adb Fix broken link to tutorial.md (#358)
The link to the `tutorial.md` file was referencing an invalid path. I
made it a relative path the tutorial markdown file.
2025-07-18 23:57:29 -07:00
Di Warachet S. 78d4422a43 Docs: Add macOS 15 container-to-container communication limitation note to the tutorial (#328)
Add note about macOS 15 network isolation preventing
container-to-container communication

Ref: https://github.com/apple/container/issues/326
2025-07-15 16:15:52 -07:00
Sidhartha Mani 6d804620a5 [Build] Disable rosetta during builds with a UserDefault (#273)
Fixes https://github.com/apple/container/issues/103
2025-07-01 14:52:41 -07:00
Aditya Ramani 9a14630623 Docs for shell completion (#275)
Closes https://github.com/apple/container/issues/93

Signed-off-by: Aditya Ramani <a_ramani@apple.com>
2025-07-01 11:12:21 -04:00
J Logan 3b5c253059 Adds container network for macOS 26. (#243)
See discussion below for example. For multiple network interfaces in a
single container we'll want to integrate against a containerization that
includes apple/containerization#156.

The change bumps the containerization dependency to 0.2.0 and addresses
the breaking API changes.

```console
% container network
OVERVIEW: Manage container networks

USAGE: container network <subcommand>

OPTIONS:
  --version               Show the version.
  -h, --help              Show help information.

SUBCOMMANDS:
  create                  Create a new network
  delete, rm              Delete one or more networks
  list, ls                List networks
  inspect                 Display information about one or more networks

  See 'container help network <subcommand>' for detailed help.
```
2025-06-27 14:12:29 -07:00
John Spurlock 90083956c2 Fix typo in technical-overview.md (#253) 2025-06-24 10:08:16 -07:00
Dmitry Kovba 05798f38a1 Update the names of Xcode and macOS (#123)
This PR updates the names of Xcode and macOS to the official names used
in https://developer.apple.com/download/applications/.
2025-06-13 16:58:28 -07:00
vadikgo e3cc50746c Update technical-overview.md doc with current code (#86)
com.apple.container.defaults default subnet key must be network.subnet,
not default.subnet.


https://github.com/apple/container/blob/ef4462ead7449eba48c0b682b93e30930047f9ef/Sources/Services/ContainerNetworkService/AllocationOnlyVmnetNetwork.swift#L70
2025-06-10 17:34:28 -07:00
owenarthur f1e9f0143c Clean up typos in docs, fix reference to default subnet (#71) 2025-06-09 17:40:27 -07:00
Michael Crosby 0fd869231e add NOTE on default registry (#53)
Signed-off-by: crosbymichael <michael_crosby@apple.com>
2025-06-09 11:56:37 -07:00
Madhu Venugopal e933ff3c53 Updating latest macOS and Xcode versions (#49)
Co-authored-by: madhu <mvenugopal@apple.com>
2025-06-09 10:33:51 -07:00
J Logan e6c49b4176 Update HTML output in tutorial, how-to. (#47) 2025-06-09 09:43:31 -07:00
J Logan 5a43b0abac Use python:alpine for tutorial. (#46) 2025-06-09 07:52:52 -07:00
Eric Ernst 8fcbd01678 docs: update version description (#42)
Updating version descriptions so we're consistent across repos.

Signed-off-by: Eric Ernst <eric_ernst@apple.com>
2025-06-08 18:02:44 -07:00
J Logan ff59bb38e8 Use bookworm in tutorial, disable console block copy. (#39)
- Switched to use bookworm Python image as `curl` is not in slim.
- Use `pre` tags for console blocks. We lose syntax highlighting, but
get rid of the copy button.
- Fix `dockerfile` tag in tutorial.
- Fix GitHub typo in README.
2025-06-08 17:30:40 -07:00
J Logan 6690f6d076 Corrections and refinements for user documentation. (#35) 2025-06-07 21:00:47 -07:00
J Logan 94e06e28a0 Refine user documentation. (#24)
- Extract README sections into BUILDING and CONTRIBUTING documents. This
should work better than sections in README as it keeps the README short,
and the BUILDING and CONTRIBUTING files will stand out in the file list.
- Merged localdev document into BUILDING.
- Fixed broken links.
- Changed DNS setup so later DNS-dependent steps should work.
- Added h1 and link to SECURITY document.
2025-06-05 18:50:40 -07:00
Joseph Heck f17c2f216c README updates (#17)
- break up readme into separate files
- rework hedaings on Code of Conduct
- Add a CONTRIBUTORS.txt
2025-06-05 15:53:50 -07:00
J Logan d9e7b71cb3 Addresses remaining TODO items in user documentation. (#4)
* Addresses remaining TODO items in user documentation.

* Add functional model diagram.
2025-06-05 15:52:31 -07:00
Kathryn Baldauf 31a0cb2f4e Update alpine images used (#1)
Signed-off-by: Kathryn Baldauf <k_baldauf@apple.com>
2025-06-05 15:52:13 -07:00
Kathryn Baldauf 8e9670c8f8 Initial commit
Co-authored-by: Aditya Ramani <a_ramani@apple.com>
Co-authored-by: Agam Dua <agam_dua@apple.com>
Co-authored-by: Danny Canter <danny_canter@apple.com>
Co-authored-by: Dmitry Kovba <dkovba@apple.com>
Co-authored-by: Eric Ernst <eric_ernst@apple.com>
Co-authored-by: Evan Hazlett <ehazlett@apple.com>
Co-authored-by: Gilbert Song <gilbertsong@apple.com>
Co-authored-by: Hugh Bussell <hbussell@apple.com>
Co-authored-by: John Logan <john_logan@apple.com>
Co-authored-by: Kathryn Baldauf <k_baldauf@apple.com>
Co-authored-by: Madhu Venugopal <mvenugopal@apple.com>
Co-authored-by: Michael Crosby <michael_crosby@apple.com>
Co-authored-by: Sidhartha Mani <sidhartha_mani@apple.com>
Co-authored-by: Tanweer Noor <tnoor@apple.com>
Co-authored-by: Ximena Perez Diaz <xperez528@gmail.com>
Co-authored-by: Yibo Zhuang <yzhuang@apple.com>
2025-06-05 15:51:55 -07:00