toolshed/docker-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
10,073 Commits 3 Branches 295 Tags
19279c9e537ff1aa951d07aba86f8b754795e22f
Commit Graph
55 Commits
Author SHA1 Message Date
David Karlsson 0a8bb6e5b4 chore: regenerate docs 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
(cherry picked from commit dc22572e3e)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-07-05 15:20:48 +02:00
Albin Kerouanton db2672e685 network create: make --ipv6 optional 
The API field `EnableIPv6` was marked as optional in our Swagger docs,
and its default value in the Go client came from that field being a
bool, thus defaulting to its zero value. That's not the case anymore.

This field is now a `*bool` as to let daemon's config define the default
value. IPv6 can still be enabled / disabled by explicitly specifying the
`--ipv6` flag when doing `docker network create`.

Signed-off-by: Albin Kerouanton <albinker@gmail.com>
 2024-06-07 03:17:46 +02:00
Rob MurrayandBjorn Neergaard 617377c045 Describe an 'internal' network. 
Added a description of a '--internal' network (from @neersighted).

Co-authored-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
Signed-off-by: Rob Murray <rob.murray@docker.com>
 2024-03-11 09:13:25 +00:00
Rob Murray 860b4f3a7d 'docker daemon' flags refer to the default bridge 
Replace 'docker daemon' with the wording used for the preceeding table,
to make it extra-clear that those flags apply to the default bridge.

Signed-off-by: Rob Murray <rob.murray@docker.com>
 2024-03-08 17:11:28 +00:00
Craig OsterhoutSebastiaan van StijnDavid Karlsson
 		5eac07b103 update typos and style in docs 
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
 2023-12-19 19:30:55 +01:00
Sebastiaan van Stijn 0a94d85cd6 docs: fix typo in "network create" docs 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2023-12-11 22:33:52 +01:00
Kevin AlvarezandSebastiaan van Stijn 79c9e527a3 docs: generate markdown 
Keep frontmatter for docker, dockerd and index markdown files.
Also needs to move cli.md > docker.md before generation and
then move it back because cli.md is needed for yaml generation on docs
website: https://github.com/docker/cli/pull/3924#discussion_r1059986605

Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2023-01-06 22:36:47 +01:00
CrazyMaxandSebastiaan van Stijn 186dcf30b1 docs: fix anchors 
Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2023-01-06 22:36:03 +01:00
Sebastiaan van Stijn 28e2b92b58 docs: remove documentation about deprecated cluster-store 
This removes documentation related to legacy overlay networks using
an external k/v store.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-05-17 11:00:51 +02:00
Sebastiaan van Stijn 2b976720f4 docs: add anchor-tags for flags 
This will generate "details_url" for options, so that the options
table on the pages at docs.docker.com link to the section describing
the option.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-30 15:05:29 +02:00
Sebastiaan van Stijn 885f44a5ba docs: fix (table) formatting, fix some broken links 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-30 15:03:25 +02:00
Sebastiaan van Stijn 47ba76afb1 docs: use "console" code-hint for shell examples 
This replaces the use of bash where suitable, to allow easier copy/pasting
of shell examples without copying the prompt or process output.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-08-21 18:29:13 +02:00
OKA Naoya 10e909a26c docs: Fix wrong bridge driver option 
Signed-off-by: OKA Naoya <git@okanaoya.com>
 2021-03-02 15:02:58 +09:00
Sebastiaan van Stijn e6ef3349f6 update docs usage output to match new format 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-10-02 15:51:01 +02:00
Dominik Braunanddominikbraun 84a07a9977 Add container_iface_prefix option to documentation 
Signed-off-by: dominikbraun <braun@sternentstehung.de>
 2020-04-24 12:39:24 +02:00
Sebastiaan van Stijn f30bde6adb remove unneeded comment from reference files 
these markdown files are not consumed directly in the docs,
but only their content is included through the YAML does,
so there's no need to have these comments in them

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-03-19 15:15:23 +01:00
Oscar WiemanandOscar Wieman 2d6aec78a1 Change example networks 
Signed-off-by: Oscar Wieman <oscar@oscarr.nl>
 2020-01-06 13:39:02 +01:00
Comical DERSKEAL 0076ee6cd5 Fix typo 
Signed-off-by: Derskeal <27731088+derskeal@users.noreply.github.com>
 2019-10-15 10:33:54 +01:00
Misty Stanley-Jones 6085b5d3aa Doc guidance to only use 256 IPs per overlay 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2018-01-30 15:41:53 -08:00
Abdur Rehman c3fe9d85ef fix a number of minor typos 
Fix 19 typos, grammatical errors and duplicated words.

These fixes have minimal impact on the code as these are either in the
doc files or in comments inside the code files.

Signed-off-by: Abdur Rehman <abdur_rehman@mentor.com>
 2017-10-31 15:21:51 +05:00
Frieder Bluemle 45c9b9b6c1 Fix GitHub spelling 
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com>
 2017-10-05 01:14:31 +08:00
bryfryandbryfry 6118658f73 Make the example match the documentation 
the missing `driver` made my bridge not have the correct MTU when i copied from the example and not the doc table.  Brings them into alignment.

Signed-off-by: bryfry <bryon@fryer.io>
 2017-08-11 21:47:34 -04:00
Kir Kolyshkin 6d85a4f5f8 Fix repo references in docs 
Since CLI was moved to a separate repo, these references are incorrect.
Fixed with the help of sed script, verified manually.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
 2017-07-28 10:32:42 -07:00
Alessandro BochandTibor Vass cccd6379b7 Docs and manual changes 
- for service create on node-local networks

Signed-off-by: Alessandro Boch <aboch@docker.com>
 2017-06-02 00:11:05 +00:00
Alessandro BochandTibor Vass bf7ba6964b Allow user to modify ingress network 
Signed-off-by: Alessandro Boch <aboch@docker.com>
 2017-06-02 00:11:00 +00:00
Misty Stanley-JonesandTibor Vass ddadd3db49 Standardized formatting of CLI reference commands 
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:53 +00:00
Harald AlbersandTibor Vass a325d3ea2a Add docs for docker network create --attachable 
Signed-off-by: Harald Albers <github@albersweb.de>
 2017-06-02 00:10:44 +00:00
Gaetan de VilleleandTibor Vass 572c6bb89a fix frontmatter keywords value type (string, instead of []string) in /docs/reference 
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
 2017-06-02 00:10:31 +00:00
Akihiro SudaandTibor Vass 8f0be436cd add docker network prune 
`docker network prune` prunes unused networks, including overlay ones.
`docker system prune` also prunes unused networks.

Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
 2017-06-02 00:10:28 +00:00
lixiaobing10051267andTibor Vass 4865a342fb fix wrong location for network related doc files 
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
 2017-06-02 00:10:26 +00:00
Misty Stanley-JonesandTibor Vass 7f36c3a1a0 Sync docker/docker refs with files mistakenly edited in docker.github.io repo 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:26 +00:00
Misty Stanley-JonesandTibor Vass 2845676cc2 Convert Markdown frontmatter to YAML 
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:24 +00:00
Sebastiaan van StijnandTibor Vass 676773a780 Fix incorrect aux-address examples and test 
The (host)name for aux-addresses should
be unique, otherwise later values overwrite
earlier values.

Before this change, the example command
would send this API request;

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "a": "192.170.1.5",
              "b": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

After this change, the request looks
like this (all aux-addresses preserved);

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "AuxiliaryAddresses": {
              "my-router": "192.168.1.5",
              "my-switch": "192.168.1.6"
            },
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "my-printer": "192.170.1.5",
              "my-nas": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2017-06-02 00:10:12 +00:00
Alessandro BochandTibor Vass f9832ceac0 Fix mtu option in documentation 
Signed-off-by: Alessandro Boch <aboch@docker.com>
 2017-06-02 00:10:10 +00:00
lixiaobing10051267andTibor Vass eb1b81c204 provide actual command format for docker network create 
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
 2017-06-02 00:10:08 +00:00
Charles SmithandTibor Vass 32a613412e add overlay networking security model node 
Signed-off-by: Charles Smith <charles.smith@docker.com>
 2017-06-02 00:10:05 +00:00
allencloudandTibor Vass eb0a4426e2 better command docker network create -h output 
Signed-off-by: allencloud <allen.sun@daocloud.io>
 2017-06-02 00:07:51 +00:00
Arnaud Porterie (icecrime)andTibor Vass 253a5f4ea2 Rename --net to --network 
Add a `--network` flag which replaces `--net` without deprecating it
yet. The `--net` flag remains hidden and supported.

Add a `--network-alias` flag which replaces `--net-alias` without deprecating
it yet. The `--net-alias` flag remains hidden and supported.

Signed-off-by: Arnaud Porterie (icecrime) <arnaud.porterie@docker.com>
 2017-06-02 00:07:50 +00:00
Alan ThompsonandTibor Vass bd67dfdd33 Update network_create.md 
minor typos and punctuation.

Signed-off-by: Alan Thompson <cloojure@gmail.com>
 2017-06-02 00:07:47 +00:00
Sebastiaan van StijnandTibor Vass bb0afa7381 network docs cleanup 
This fixes some Markup and formatting
issues in the network documentation;

- wrap text to 80 chars
- add missing language hints for code examples
- add missing line continuations (\)
- update USAGE output for Cobra

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2017-06-02 00:07:42 +00:00
Shijiang WeiandTibor Vass d04810fa14 docs: correct network create command 
Signed-off-by: Shijiang Wei <mountkin@gmail.com>
 2017-06-02 00:07:42 +00:00
Harald AlbersandTibor Vass f3f9b34d2a docs for labels on build, networks and volumes 
Signed-off-by: Harald Albers <github@albersweb.de>
 2017-06-02 00:07:33 +00:00
Zhang WeiandTibor Vass d219111855 Fix typo 
Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
 2017-06-02 00:07:32 +00:00
Aidan Hobson SayersandTibor Vass 543ca10394 Update docs for enableipv6 
Signed-off-by: Aidan Hobson Sayers <aidanhs@cantab.net>
 2017-06-02 00:07:30 +00:00
Aidan Hobson SayersandTibor Vass 65c94a34be Add docs for --ipv6 option, also add --internal as appropriate 
Signed-off-by: Aidan Hobson Sayers <aidanhs@cantab.net>
 2017-06-02 00:07:29 +00:00
Wen Cheng MaandTibor Vass 27686523be docs: document options for default network driver 
Fixes issue #18410

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
 2017-06-02 00:07:27 +00:00
Ryan BelgraveandTibor Vass 82e9cba6d4 Add IPAM Config Options to match libnetwork 
Signed-off-by: Ryan Belgrave <rmb1993@gmail.com>
 2017-06-02 00:07:24 +00:00
Chun ChenandTibor Vass 3f5817fdae Add network interal mode 
Signed-off-by: Chun Chen <ramichen@tencent.com>
Signed-off-by: David Calavera <david.calavera@gmail.com>
 2017-06-02 00:07:23 +00:00
Doug DavisandTibor Vass 421578fbd4 remove =false from options that default to false in the docs 
This re-aligns the docs with what the cmd line now does.

Signed-off-by: Doug Davis <dug@us.ibm.com>
 2017-06-02 00:07:21 +00:00
Chris WeylandTibor Vass 66eef79e58 newtork -> network (minor spelling correction) 
...yeah, that was bugging me. :)

Signed-off-by: Chris Weyl <cweyl@alumni.drew.edu>
 2017-06-02 00:07:19 +00:00