From 2fc1094c74172f16b59d66c460a693dd1099e445 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 14 Aug 2024 13:51:19 +0200 Subject: [PATCH 01/11] netlify: bump hugo version for preview deployments to v0.132.0 Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- netlify.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netlify.toml b/netlify.toml index 3ffadfae05..ede05520bf 100644 --- a/netlify.toml +++ b/netlify.toml @@ -4,7 +4,7 @@ publish = "public" [context.deploy-preview.environment] NODE_VERSION = "20" NODE_ENV = "production" -HUGO_VERSION = "0.127.0" +HUGO_VERSION = "0.132.0" HUGO_ENABLEGITINFO = "true" HUGO_ENVIRONMENT = "preview" From 50b97b01d547305900d140abb9b5ff1a57adf7f0 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:26:53 +0200 Subject: [PATCH 02/11] lint: disable warning for reference links with shortcut syntax The shortcut syntax is used by GitHub-style alerts and trigger a lint warning. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .markdownlint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.markdownlint.json b/.markdownlint.json index 29ecb5426f..58ab5995dd 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -16,7 +16,7 @@ "ol-prefix": {"style": "ordered"}, "no-reversed-links": true, "reference-links-images": { - "shortcut_syntax": true + "shortcut_syntax": false }, "fenced-code-language": true, "table-pipe-style": true, From ea6246b05948764dd71368a7051f6f6fcf090a2c Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 14 Aug 2024 10:56:15 +0200 Subject: [PATCH 03/11] hugo: use render hook for callouts Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- assets/css/callouts.css | 70 ------------------- assets/css/styles.css | 1 - hugo_stats.json | 12 ++-- i18n/en.yaml | 9 +++ .../_default/_markup/render-blockquote.html | 41 +++++++++++ layouts/partials/head.html | 1 - layouts/partials/utils/resources.html | 11 --- tailwind.config.js | 7 +- 8 files changed, 60 insertions(+), 92 deletions(-) delete mode 100644 assets/css/callouts.css create mode 100644 layouts/_default/_markup/render-blockquote.html delete mode 100644 layouts/partials/utils/resources.html diff --git a/assets/css/callouts.css b/assets/css/callouts.css deleted file mode 100644 index 9a2aaac119..0000000000 --- a/assets/css/callouts.css +++ /dev/null @@ -1,70 +0,0 @@ -/* callouts = blockquotes with classes - * - * Note: the left border is set using a custom property - * in tailwind.config.js - * - * */ - -@layer components { - .prose blockquote { - @apply bg-blue-light-100 px-6 py-4 font-normal not-italic dark:bg-blue-dark-100; - quotes: none; - > *:first-child { - @apply relative ml-6 mt-0; - &:before { - @apply bg-black dark:bg-white; - position: absolute; - display: block; - margin-left: -24px; - margin-top: 4px; - width: 20px; - height: 20px; - mask-image: url('/icons/info-fill.svg'); - -webkit-mask-image: url('/icons/info-fill.svg'); - mask-repeat: no-repeat; - mask-size: cover; - } - } - *:last-child { - @apply mb-0 after:content-none; - } - - &.warning { - @apply border-l-red-light bg-red-light-100 dark:border-l-red-dark dark:bg-red-dark-100; - > *:first-child:before { - mask-image: url('/icons/dangerous-fill.svg'); - -webkit-mask-image: url('/icons/dangerous-fill.svg'); - } - } - - &.important { - @apply border-l-amber-light bg-amber-light-100 dark:border-l-amber-dark dark:bg-amber-dark-100; - > *:first-child:before { - mask-image: url('/icons/warning-fill.svg'); - -webkit-mask-image: url('/icons/warning-fill.svg'); - } - } - - &.tip { - @apply border-l-green-light bg-green-light-100 dark:border-l-green-dark dark:bg-green-dark-100; - > *:first-child:before { - mask-image: url('/icons/lightbulb-fill.svg'); - -webkit-mask-image: url('/icons/lightbulb-fill.svg'); - } - } - - &.experimental { - > *:first-child:before { - mask-image: url('/icons/science-fill.svg'); - -webkit-mask-image: url('/icons/science-fill.svg'); - } - } - &.restricted { - @apply border-l-violet-light bg-violet-light-100 dark:border-l-violet-dark dark:bg-violet-dark-100; - > *:first-child:before { - mask-image: url('/icons/rocket_launch-fill.svg'); - -webkit-mask-image: url('/icons/rocket_launch-fill.svg'); - } - } - } -} diff --git a/assets/css/styles.css b/assets/css/styles.css index c387b5c175..b086132154 100644 --- a/assets/css/styles.css +++ b/assets/css/styles.css @@ -8,7 +8,6 @@ @import "tailwindcss/components"; @import "/assets/css/code"; @import "/assets/css/toc"; -@import "/assets/css/callouts"; @import "/assets/css/kapa"; @import "tailwindcss/utilities"; diff --git a/hugo_stats.json b/hugo_stats.json index eb97df3ffb..8652c7d76a 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -42,10 +42,13 @@ "Editor-or-IDE", "Entra-ID", "Entra-ID-SAML-2.0", + "External-cloud-storage", "Fedora", "For-Mac-with-Apple-silicon", "For-Mac-with-Intel-chip", "For-all-platforms", + "From-the-GUI", + "From-the-command-line", "GUI", "Git-Bash", "Git-Bash-CLI", @@ -58,14 +61,14 @@ "Hub", "Hyper-V-backend-x86_64", "Inline", - "Install-from-the-command-line", - "Install-interactively", "JSON", "Java", "JavaScript", "Jenkins", "Latest", "Linux", + "Local-or-Hub-storage", + "MDM", "Mac", "Mac-/-Linux", "Mac-/-Linux-/-Git-Bash", @@ -94,6 +97,7 @@ "Run-Ollama-in-a-container", "Run-Ollama-outside-of-a-container", "Shell", + "Shell-script", "Specific-version", "Svelte", "Travis-CI", @@ -165,6 +169,7 @@ "border-divider-light", "border-gray-light-100", "border-gray-light-200", + "border-l-4", "bottom-0", "box-content", "build-push-action", @@ -229,7 +234,6 @@ "drop-shadow", "drop-shadow-sm", "duration-300", - "experimental", "fill-blue-light", "fixed", "flex", @@ -288,7 +292,6 @@ "icon-sm", "icon-svg", "important", - "information", "inline", "inset-0", "invertible", @@ -403,7 +406,6 @@ "py-4", "py-8", "relative", - "restricted", "right-0", "right-3", "right-8", diff --git a/i18n/en.yaml b/i18n/en.yaml index a6f797b9db..fe37067f13 100644 --- a/i18n/en.yaml +++ b/i18n/en.yaml @@ -9,6 +9,15 @@ tableOfContents: relatedContent: other: Related content +## callout titles: + +experimental: Experimental +restricted: Restricted +important: Important +note: Note +tip: Tip +warning: Warning + ## openapi strings: apiExampleResponse: diff --git a/layouts/_default/_markup/render-blockquote.html b/layouts/_default/_markup/render-blockquote.html new file mode 100644 index 0000000000..dbc10f9996 --- /dev/null +++ b/layouts/_default/_markup/render-blockquote.html @@ -0,0 +1,41 @@ +{{- $icons := dict + "caution" "dangerous" + "important" "report" + "note" "info" + "tip" "lightbulb" + "warning" "warning" +}} +{{- $borders := dict + "caution" "border-red-light dark:border-red-dark" + "important" "border-violet-light dark:border-violet-dark" + "note" "border-blue-light dark:border-blue-dark" + "tip" "border-green-light dark:border-green-dark" + "warning" "border-amber-light dark:border-amber-dark" +}} +{{- $textColors := dict + "caution" "text-red-light dark:text-red-dark" + "important" "text-violet-light dark:text-violet-dark" + "note" "text-blue-light dark:text-blue-dark" + "tip" "text-green-light dark:text-green-dark" + "warning" "text-amber-light dark:text-amber-dark" +}} + +{{ if eq .Type "alert" }} +
+

+ {{ $i := index $icons .AlertType }} + {{ partialCached "icon.html" $i $i }} + + {{ or (i18n .AlertType) (title .AlertType) }} +

+ {{ .Text | safeHTML }} +
+{{ else }} +
+ {{ .Text | safeHTML }} +
+{{ end }} diff --git a/layouts/partials/head.html b/layouts/partials/head.html index d274311f5b..0815cdbd61 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -85,4 +85,3 @@ | js.Build (dict "minify" true "targetPath" "scripts.js") }} -{{ partialCached "utils/resources.html" "-" }} diff --git a/layouts/partials/utils/resources.html b/layouts/partials/utils/resources.html deleted file mode 100644 index e1cfedf119..0000000000 --- a/layouts/partials/utils/resources.html +++ /dev/null @@ -1,11 +0,0 @@ -{{/* meta partial for publishing resources */}} -{{ $icons := slice }} -{{ $icons = $icons | append (resources.Get "icons/info-fill.svg") }} -{{ $icons = $icons | append (resources.Get "icons/dangerous-fill.svg") }} -{{ $icons = $icons | append (resources.Get "icons/warning-fill.svg") }} -{{ $icons = $icons | append (resources.Get "icons/lightbulb-fill.svg") }} -{{ $icons = $icons | append (resources.Get "icons/science-fill.svg") }} -{{ $icons = $icons | append (resources.Get "icons/rocket_launch-fill.svg") }} -{{ range $icons }} - {{ .Publish}} -{{ end }} diff --git a/tailwind.config.js b/tailwind.config.js index 53096b7fc1..9d9bd88766 100644 --- a/tailwind.config.js +++ b/tailwind.config.js @@ -12,6 +12,9 @@ module.exports = { 'pre code': false, 'code::before': false, 'code::after': false, + blockquote: false, + 'blockquote p:first-of-type::before': false, + 'blockquote p:last-of-type::after': false, // light colors for prose "--tw-prose-body": theme("colors.black"), "--tw-prose-headings": theme("colors.black"), @@ -21,8 +24,6 @@ module.exports = { "--tw-prose-counters": theme("colors.black"), "--tw-prose-bullets": theme("colors.black"), "--tw-prose-hr": theme("colors.divider.light"), - "--tw-prose-quotes": theme("colors.black"), - "--tw-prose-quote-borders": theme("colors.blue.light.500"), "--tw-prose-captions": theme("colors.gray.light.600"), "--tw-prose-th-borders": theme("colors.gray.light.200"), "--tw-prose-td-borders": theme("colors.gray.light.200"), @@ -36,8 +37,6 @@ module.exports = { "--tw-prose-invert-counters": theme("colors.white"), "--tw-prose-invert-bullets": theme("colors.white"), "--tw-prose-invert-hr": theme("colors.divider.dark"), - "--tw-prose-invert-quotes": theme("colors.white"), - "--tw-prose-invert-quote-borders": theme("colors.blue.dark.500"), "--tw-prose-invert-captions": theme("colors.gray.dark.600"), "--tw-prose-invert-th-borders": theme("colors.gray.dark.200"), "--tw-prose-invert-td-borders": theme("colors.gray.dark.200"), From 4df0ee12c54a27f375d65662ad2e55aeab7956ef Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 11:01:01 +0200 Subject: [PATCH 04/11] hugo: add experimental shortcode Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- layouts/shortcodes/experimental.html | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 layouts/shortcodes/experimental.html diff --git a/layouts/shortcodes/experimental.html b/layouts/shortcodes/experimental.html new file mode 100644 index 0000000000..b1aa1f37bc --- /dev/null +++ b/layouts/shortcodes/experimental.html @@ -0,0 +1,9 @@ +
+

+ + {{ partialCached "icon.html" "science" "science" }} + + {{ .Get "title" | default "Experimental" }} +

+ {{ .InnerDeindent | safe.HTML }} +
From 43810e618d5b8932e62bfdfd86d51e8a2844036e Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 17:06:39 +0200 Subject: [PATCH 05/11] hugo: add restricted shortcode Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- layouts/shortcodes/restricted.html | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 layouts/shortcodes/restricted.html diff --git a/layouts/shortcodes/restricted.html b/layouts/shortcodes/restricted.html new file mode 100644 index 0000000000..8256d2b9e1 --- /dev/null +++ b/layouts/shortcodes/restricted.html @@ -0,0 +1,9 @@ +
+

+ + {{ partialCached "icon.html" "rocket_launch" "rocket_launch" }} + + {{ .Get "title" | default "Restricted" }} +

+ {{ .InnerDeindent | safe.HTML }} +
From 0f4bb635f51b8de0c8965e821de08eb0d45f85dc Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 17:05:56 +0200 Subject: [PATCH 06/11] hugo: update alerts in cli template Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- hugo_stats.json | 11 ++++++++++- layouts/_default/cli.html | 36 ++++++++++++++++++------------------ 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/hugo_stats.json b/hugo_stats.json index 8652c7d76a..bb6b3b8896 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -161,6 +161,7 @@ "block", "border", "border-0", + "border-amber-light", "border-b-2", "border-b-4", "border-b-gray-light-400", @@ -169,7 +170,9 @@ "border-divider-light", "border-gray-light-100", "border-gray-light-200", + "border-l-2", "border-l-4", + "border-l-magenta-light", "bottom-0", "box-content", "build-push-action", @@ -196,12 +199,14 @@ "dark:bg-red-dark", "dark:bg-violet-dark", "dark:block", + "dark:border-amber-dark", "dark:border-b-blue-dark-600", "dark:border-b-gray-dark-400", "dark:border-b-green-dark-400", "dark:border-divider-dark", "dark:border-gray-dark-200", "dark:border-gray-dark-400", + "dark:border-l-magenta-dark", "dark:decoration-blue-dark", "dark:fill-blue-dark", "dark:focus:outline-blue-dark", @@ -216,6 +221,7 @@ "dark:outline-gray-dark", "dark:prose-invert", "dark:syntax-dark", + "dark:text-amber-dark", "dark:text-blue-dark", "dark:text-divider-dark", "dark:text-gray-dark", @@ -223,6 +229,7 @@ "dark:text-gray-dark-600", "dark:text-gray-dark-700", "dark:text-gray-dark-800", + "dark:text-magenta-dark", "dark:text-violet-dark", "dark:text-white", "dark:to-blue-dark-100", @@ -291,7 +298,6 @@ "icon-lg", "icon-sm", "icon-svg", - "important", "inline", "inset-0", "invertible", @@ -382,6 +388,7 @@ "p-[2px]", "pb-0", "pb-0.5", + "pb-1", "pb-2", "pb-32", "pb-4", @@ -434,6 +441,7 @@ "syntax-light", "systemd-networkd", "text-2xl", + "text-amber-light", "text-base", "text-black", "text-blue-light", @@ -446,6 +454,7 @@ "text-gray-light-800", "text-left", "text-lg", + "text-magenta-light", "text-sm", "text-violet-light", "text-white", diff --git a/layouts/_default/cli.html b/layouts/_default/cli.html index caea937496..e96b19ff4f 100644 --- a/layouts/_default/cli.html +++ b/layouts/_default/cli.html @@ -48,26 +48,26 @@ {{ .Content }} {{ if $data.deprecated }} -
-

This command is deprecated

-

- It may be removed in a future Docker version. For more information, - see the - Docker roadmap -

-
+ {{ markdownify ` +> [!WARNING] +> This command is deprecated +> +> It may be removed in a future Docker version. For more information, see the +> [Docker roadmap](https://github.com/docker/roadmap/issues/209)` + }} {{ end }} {{ if or $data.experimental $data.experimentalcli }} -
-

This command is experimental

-

- Experimental features are intended for testing and feedback as their - functionality or design may change between releases without warning or - can be removed entirely in a future release. -

-
+ {{ markdownify ` +{{% experimental %}} + +**This command is experimental.** + +Experimental features are intended for testing and feedback as their +functionality or design may change between releases without warning or +can be removed entirely in a future release. + +{{% /experimental %}}` + }} {{ end }} {{ with $data.kubernetes }}

From e3aa78b72c9faf56e97896681c33425cafc1c847 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 09:43:43 +0200 Subject: [PATCH 07/11] chore: update alert syntax Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/accounts/_index.md | 2 +- content/accounts/create-account.md | 14 ++--- content/accounts/deactivate-user-account.md | 6 +-- content/accounts/manage-account.md | 5 +- content/admin/_index.md | 2 +- content/admin/company/_index.md | 2 +- content/admin/company/new-company.md | 6 +-- content/admin/company/organizations.md | 4 -- content/admin/company/owners.md | 2 +- content/admin/convert-account.md | 3 +- content/admin/deactivate-account.md | 4 +- content/admin/organization/activity-logs.md | 2 +- content/admin/organization/manage-a-team.md | 2 +- content/admin/organization/members.md | 6 +-- content/admin/organization/orgs.md | 9 ++-- content/billing/3d-secure.md | 5 +- content/billing/build-billing.md | 5 +- content/billing/core-billing/cycle.md | 2 +- content/billing/core-billing/details.md | 5 +- content/billing/core-billing/history.md | 2 +- .../billing/core-billing/payment-method.md | 2 +- content/billing/scout-billing.md | 7 ++- content/billing/tax-certificate.md | 3 +- content/build-cloud/_index.md | 2 +- content/build-cloud/ci.md | 4 +- content/build-cloud/usage.md | 9 ++-- content/build/attestations/_index.md | 4 +- content/build/attestations/sbom.md | 6 +-- content/build/attestations/slsa-provenance.md | 3 +- content/build/bake/compose-file.md | 2 +- content/build/building/annotations.md | 2 +- content/build/building/best-practices.md | 6 +-- content/build/building/context.md | 4 +- content/build/building/multi-platform.md | 4 +- content/build/building/packaging.md | 7 ++- content/build/building/variables.md | 3 +- content/build/buildkit/_index.md | 9 ++-- content/build/buildkit/configure.md | 2 +- content/build/cache/backends/_index.md | 5 +- content/build/cache/garbage-collection.md | 2 +- .../build/ci/github-actions/annotations.md | 2 +- .../build/ci/github-actions/attestations.md | 3 +- content/build/ci/github-actions/cache.md | 5 +- .../build/ci/github-actions/multi-platform.md | 2 +- content/build/ci/github-actions/secrets.md | 4 +- .../ci/github-actions/test-before-push.md | 2 +- content/build/dockerfile/frontend.md | 2 +- content/build/drivers/docker-container.md | 2 +- content/build/drivers/kubernetes.md | 5 +- content/build/exporters/_index.md | 2 +- content/build/guide/_index.md | 2 +- content/compose/_index.md | 2 +- .../compose/bridge/advanced-integration.md | 2 +- content/compose/bridge/customize.md | 2 +- content/compose/bridge/usage.md | 7 ++- content/compose/compose-application-model.md | 2 +- .../compose-file/04-version-and-name.md | 2 +- content/compose/compose-file/05-services.md | 17 +++--- content/compose/compose-file/07-volumes.md | 3 +- content/compose/compose-file/09-secrets.md | 2 +- content/compose/compose-file/10-fragments.md | 2 +- content/compose/compose-file/11-extension.md | 2 +- content/compose/compose-file/15-profiles.md | 2 +- content/compose/compose-file/_index.md | 1 - content/compose/compose-file/deploy.md | 2 +- content/compose/compose-file/develop.md | 2 +- .../compose/compose-file/legacy-versions.md | 2 +- .../compose/environment-variables/_index.md | 3 +- .../compose/environment-variables/envvars.md | 4 +- .../set-environment-variables.md | 4 +- .../variable-interpolation.md | 8 ++- content/compose/file-watch.md | 4 +- content/compose/gettingstarted.md | 7 ++- content/compose/gpu-support.md | 3 +- content/compose/install/_index.md | 6 +-- content/compose/install/linux.md | 4 +- content/compose/install/standalone.md | 5 +- content/compose/install/uninstall.md | 5 +- content/compose/migrate.md | 10 ++-- .../compose/multiple-compose-files/extends.md | 3 +- .../compose/multiple-compose-files/include.md | 2 +- .../compose/multiple-compose-files/merge.md | 3 +- content/compose/networking.md | 5 +- content/compose/production.md | 2 +- content/compose/profiles.md | 3 +- content/compose/project-name.md | 2 +- content/compose/release-notes.md | 16 +++--- content/compose/use-secrets.md | 2 +- content/contribute/checklist.md | 2 +- content/contribute/components/buttons.md | 2 +- content/contribute/components/call-outs.md | 25 +++------ content/contribute/components/cards.md | 4 +- content/contribute/components/links.md | 2 +- content/contribute/components/lists.md | 4 +- content/contribute/components/tables.md | 2 +- content/contribute/style/terminology.md | 2 +- content/contribute/style/voice-tone.md | 2 +- content/desktop/allow-list.md | 2 +- content/desktop/backup-and-restore.md | 1 - content/desktop/containerd.md | 2 +- .../dev-environments/create-dev-env.md | 8 ++- content/desktop/dev-environments/set-up.md | 2 +- content/desktop/dev-environments/share.md | 2 +- content/desktop/enterprise/_index.md | 2 +- content/desktop/faqs/macfaqs.md | 5 +- content/desktop/get-started.md | 4 +- content/desktop/gpu.md | 2 +- content/desktop/install/debian.md | 2 +- content/desktop/install/linux-install.md | 10 ++-- content/desktop/install/mac-install.md | 9 ++-- content/desktop/install/msi/_index.md | 2 +- .../install/msi/install-and-configure.md | 13 ++--- content/desktop/install/msi/use-intune.md | 5 +- content/desktop/install/rhel.md | 1 - content/desktop/install/ubuntu.md | 4 +- content/desktop/install/windows-install.md | 25 ++++----- content/desktop/kubernetes.md | 8 ++- .../desktop/mac/permission-requirements.md | 2 +- content/desktop/networking.md | 2 +- content/desktop/previous-versions/3.x-mac.md | 2 +- .../desktop/previous-versions/3.x-windows.md | 2 +- .../previous-versions/edge-releases-mac.md | 2 +- .../edge-releases-windows.md | 4 +- content/desktop/release-notes.md | 2 +- content/desktop/settings/linux.md | 6 +-- content/desktop/settings/mac.md | 8 +-- content/desktop/settings/windows.md | 14 +++-- content/desktop/support.md | 2 +- content/desktop/synchronized-file-sharing.md | 10 ++-- content/desktop/troubleshoot/overview.md | 7 ++- content/desktop/troubleshoot/topics.md | 3 +- content/desktop/uninstall.md | 3 +- content/desktop/use-desktop/images.md | 6 +-- content/desktop/use-desktop/pause.md | 1 - content/desktop/use-desktop/resource-saver.md | 2 +- content/desktop/use-desktop/volumes.md | 2 +- content/desktop/vm-vdi.md | 2 +- content/desktop/wsl/_index.md | 7 +-- content/docker-hub/api/deprecated.md | 3 +- content/docker-hub/api/dvp.md | 2 +- content/docker-hub/api/latest.md | 2 +- content/docker-hub/builds/_index.md | 12 ++--- content/docker-hub/builds/advanced.md | 10 ++-- .../docker-hub/builds/automated-testing.md | 9 ++-- content/docker-hub/builds/how-builds-work.md | 4 +- content/docker-hub/builds/link-source.md | 6 +-- content/docker-hub/builds/manage-builds.md | 4 +- content/docker-hub/builds/troubleshoot.md | 8 +-- content/docker-hub/mirror.md | 14 +++-- content/docker-hub/oci-artifacts.md | 2 +- content/docker-hub/quickstart.md | 3 +- content/docker-hub/release-notes.md | 1 - content/docker-hub/repos/_index.md | 5 +- content/docker-hub/repos/access.md | 4 +- content/docker-hub/repos/categories.md | 2 +- content/docker-hub/repos/create.md | 4 +- content/docker-hub/service-accounts.md | 6 +-- content/docker-hub/vulnerability-scanning.md | 4 +- content/engine/api/_index.md | 2 +- content/engine/api/sdk/_index.md | 3 +- content/engine/api/sdk/examples.md | 7 ++- content/engine/api/v1.25.md | 2 +- content/engine/api/v1.26.md | 2 +- content/engine/api/v1.27.md | 2 +- content/engine/api/v1.28.md | 2 +- content/engine/api/v1.29.md | 2 +- content/engine/api/v1.30.md | 2 +- content/engine/api/v1.31.md | 2 +- content/engine/api/v1.32.md | 2 +- content/engine/api/v1.33.md | 2 +- content/engine/api/v1.34.md | 2 +- content/engine/api/v1.35.md | 2 +- content/engine/api/v1.36.md | 2 +- content/engine/api/v1.37.md | 2 +- content/engine/api/v1.38.md | 2 +- content/engine/api/v1.39.md | 2 +- content/engine/api/v1.40.md | 2 +- content/engine/api/v1.41.md | 2 +- content/engine/api/v1.42.md | 2 +- content/engine/api/v1.43.md | 2 +- content/engine/api/v1.44.md | 2 +- content/engine/cli/formatting.md | 3 +- content/engine/cli/proxy.md | 5 +- content/engine/containers/live-restore.md | 2 +- .../engine/containers/resource_constraints.md | 5 +- content/engine/containers/runmetrics.md | 2 +- .../start-containers-automatically.md | 6 +-- content/engine/daemon/_index.md | 2 +- content/engine/daemon/alternative-runtimes.md | 2 +- content/engine/daemon/ipv6.md | 2 +- content/engine/daemon/logs.md | 2 +- content/engine/daemon/prometheus.md | 5 +- content/engine/daemon/proxy.md | 4 +- content/engine/daemon/remote-access.md | 3 +- content/engine/daemon/troubleshoot.md | 7 ++- content/engine/install/_index.md | 2 +- content/engine/install/binaries.md | 8 ++- content/engine/install/debian.md | 5 +- content/engine/install/linux-postinstall.md | 5 +- content/engine/install/raspberry-pi-os.md | 6 +-- content/engine/install/sles.md | 3 +- content/engine/install/ubuntu.md | 5 +- content/engine/logging/configure.md | 8 ++- content/engine/logging/drivers/awslogs.md | 12 ++--- content/engine/logging/drivers/etwlogs.md | 2 +- content/engine/logging/drivers/fluentd.md | 2 +- content/engine/logging/drivers/gelf.md | 4 +- content/engine/logging/drivers/json-file.md | 5 +- content/engine/logging/drivers/local.md | 3 +- content/engine/logging/drivers/splunk.md | 2 +- content/engine/logging/drivers/syslog.md | 2 +- content/engine/logging/dual-logging.md | 4 +- content/engine/network/_index.md | 6 +-- content/engine/network/drivers/host.md | 2 +- content/engine/network/drivers/ipvlan.md | 6 +-- content/engine/network/drivers/overlay.md | 5 +- content/engine/network/links.md | 16 +++--- .../network/packet-filtering-firewalls.md | 10 ++-- content/engine/network/tutorials/overlay.md | 6 +-- .../engine/network/tutorials/standalone.md | 2 +- content/engine/release-notes/17.06.md | 6 +-- content/engine/release-notes/17.10.md | 3 +- content/engine/release-notes/17.11.md | 3 +- content/engine/release-notes/20.10.md | 6 +-- content/engine/release-notes/23.0.md | 4 +- content/engine/release-notes/24.0.md | 3 +- content/engine/release-notes/25.0.md | 4 +- content/engine/release-notes/26.0.md | 4 +- content/engine/release-notes/26.1.md | 4 +- .../engine/release-notes/prior-releases.md | 2 +- content/engine/security/antivirus.md | 2 +- content/engine/security/apparmor.md | 2 +- content/engine/security/certificates.md | 6 +-- content/engine/security/https/README.md | 2 +- content/engine/security/non-events.md | 2 +- content/engine/security/protect-access.md | 21 ++++---- content/engine/security/rootless.md | 9 ++-- content/engine/security/trust/_index.md | 3 +- .../engine/security/trust/trust_automation.md | 2 +- .../engine/security/trust/trust_delegation.md | 7 ++- .../engine/security/trust/trust_key_mng.md | 8 ++- .../engine/security/trust/trust_sandbox.md | 2 +- content/engine/security/userns-remap.md | 7 ++- content/engine/storage/_index.md | 6 +-- content/engine/storage/bind-mounts.md | 10 ++-- content/engine/storage/containerd.md | 2 +- content/engine/storage/drivers/_index.md | 10 ++-- content/engine/storage/drivers/aufs-driver.md | 3 +- .../engine/storage/drivers/btrfs-driver.md | 8 +-- .../storage/drivers/device-mapper-driver.md | 9 ++-- .../storage/drivers/overlayfs-driver.md | 8 ++- .../storage/drivers/select-storage-driver.md | 5 +- content/engine/storage/drivers/zfs-driver.md | 2 +- content/engine/storage/volumes.md | 12 ++--- content/engine/swarm/_index.md | 2 +- content/engine/swarm/admin_guide.md | 6 +-- content/engine/swarm/configs.md | 6 +-- .../swarm/how-swarm-mode-works/nodes.md | 3 +- .../engine/swarm/how-swarm-mode-works/pki.md | 4 +- .../swarm/how-swarm-mode-works/services.md | 5 +- .../how-swarm-mode-works/swarm-task-states.md | 2 +- content/engine/swarm/ingress.md | 2 +- content/engine/swarm/join-nodes.md | 2 +- content/engine/swarm/key-concepts.md | 2 +- content/engine/swarm/manage-nodes.md | 4 +- content/engine/swarm/networking.md | 9 ++-- content/engine/swarm/raft.md | 2 +- content/engine/swarm/secrets.md | 18 +++---- content/engine/swarm/services.md | 24 ++++----- content/engine/swarm/stack-deploy.md | 2 +- content/engine/swarm/swarm-mode.md | 2 +- .../engine/swarm/swarm-tutorial/drain-node.md | 3 +- .../swarm/swarm-tutorial/inspect-service.md | 2 - .../swarm/swarm-tutorial/scale-service.md | 2 +- content/engine/swarm/swarm_manager_locking.md | 5 +- .../engine/tutorials/networkingcontainers.md | 2 +- .../extensions-sdk/architecture/_index.md | 10 ++-- .../extensions-sdk/architecture/security.md | 3 +- .../build/backend-extension-tutorial.md | 53 +++++++------------ .../build/frontend-extension-tutorial.md | 26 ++++----- .../build/minimal-frontend-extension.md | 3 +- .../extensions-sdk/design/_index.md | 2 +- .../design/design-principles.md | 2 +- .../extensions-sdk/dev/api/backend.md | 4 +- .../dev/api/dashboard-routes-navigation.md | 2 +- .../extensions-sdk/dev/api/dashboard.md | 2 +- .../extensions-sdk/dev/api/docker.md | 4 +- .../extensions-sdk/dev/api/overview.md | 2 +- .../dev/api/reference/interfaces/BackendV0.md | 30 ++++------- .../interfaces/DockerDesktopClient.md | 53 ++++++------------- .../dev/continuous-integration.md | 7 ++- .../extensions-sdk/dev/test-debug.md | 2 +- .../extensions-sdk/extensions/DISTRIBUTION.md | 2 +- .../extensions-sdk/extensions/_index.md | 2 +- .../extensions-sdk/extensions/labels.md | 6 +-- .../extensions-sdk/extensions/multi-arch.md | 5 +- .../extensions-sdk/extensions/publish.md | 8 ++- .../extensions-sdk/extensions/share.md | 4 +- .../extensions-sdk/extensions/validate.md | 2 +- .../guides/invoke-host-binaries.md | 13 ++--- .../extensions-sdk/guides/kubernetes.md | 3 +- .../extensions-sdk/guides/oauth2-flow.md | 9 ++-- content/extensions/extensions-sdk/process.md | 7 ++- .../extensions/extensions-sdk/quickstart.md | 5 +- content/extensions/marketplace.md | 4 +- content/extensions/non-marketplace.md | 7 ++- content/extensions/private-marketplace.md | 5 +- content/extensions/settings-feedback.md | 4 +- content/get-docker.md | 2 +- .../deployment-orchestration/kube-deploy.md | 2 +- .../deployment-orchestration/orchestration.md | 2 +- .../deployment-orchestration/swarm-deploy.md | 2 +- .../building-images/multi-stage-builds.md | 3 +- .../understanding-image-layers.md | 1 - .../building-images/writing-a-dockerfile.md | 3 -- .../multi-container-applications.md | 4 +- .../overriding-container-defaults.md | 7 +-- .../persisting-container-data.md | 1 - .../running-containers/publishing-ports.md | 3 +- .../running-containers/sharing-local-files.md | 6 +-- .../the-basics/what-is-a-container.md | 6 +-- .../the-basics/what-is-an-image.md | 1 - .../the-basics/what-is-docker-compose.md | 2 - content/guides/resources.md | 2 +- .../use-case/genai-pdf-bot/containerize.md | 4 +- .../guides/use-case/genai-pdf-bot/develop.md | 9 ++-- .../guides/use-case/genai-video-bot/_index.md | 6 +-- .../use-case/nlp/language-translation.md | 2 +- .../use-case/nlp/named-entity-recognition.md | 2 +- .../guides/use-case/nlp/sentiment-analysis.md | 2 +- .../use-case/nlp/text-classification.md | 2 +- .../guides/use-case/nlp/text-summarization.md | 2 +- content/guides/use-case/tensorflowjs.md | 2 +- content/guides/workshop/04_sharing_app.md | 7 ++- content/guides/workshop/05_persisting_data.md | 5 +- content/guides/workshop/06_bind_mounts.md | 3 +- content/guides/workshop/07_multi_container.md | 5 +- content/guides/workshop/08_using_compose.md | 1 - content/guides/workshop/10_what_next.md | 2 +- content/guides/workshop/_index.md | 2 +- content/includes/aci-ecs-eol.md | 1 - content/includes/admin-company-overview.md | 2 +- content/includes/admin-early-access.md | 2 +- content/includes/admin-org-overview.md | 2 +- content/includes/beta.md | 2 +- content/includes/buildx-v0.10-disclaimer.md | 4 +- .../includes/compose-bridge-early-access.md | 2 +- content/includes/compose-eol.md | 3 +- content/includes/compose/build.md | 2 +- content/includes/compose/configs.md | 2 +- content/includes/compose/configure-watch.md | 2 +- content/includes/compose/deploy.md | 2 +- content/includes/compose/extension.md | 2 +- content/includes/compose/fragments.md | 2 +- content/includes/compose/include.md | 2 +- content/includes/compose/interpolation.md | 2 +- content/includes/compose/merge.md | 2 +- content/includes/compose/networks.md | 2 +- content/includes/compose/profiles.md | 2 +- content/includes/compose/secrets.md | 2 +- .../includes/compose/services-depends-on.md | 2 +- content/includes/compose/services-develop.md | 2 +- content/includes/compose/services-env-file.md | 2 +- .../includes/compose/services-environment.md | 2 +- .../includes/compose/services-healthcheck.md | 2 +- content/includes/compose/services-networks.md | 2 +- content/includes/compose/services-ports.md | 2 +- content/includes/compose/services-secrets.md | 2 +- content/includes/compose/services-volumes.md | 2 +- content/includes/compose/services.md | 2 +- content/includes/compose/volumes.md | 2 +- content/includes/compose/watch.md | 2 +- content/includes/deploy.md | 2 +- content/includes/desktop-experimental.md | 2 +- content/includes/desktop-license-update.md | 2 +- content/includes/desktop-linux-launch.md | 2 +- .../desktop-notifications-settings.md | 2 +- content/includes/dev-envs-changing.md | 3 +- content/includes/dockerfile-labs-channel.md | 2 +- content/includes/experimental.md | 2 +- content/includes/extensions-form.md | 2 +- content/includes/guides-get-docker.md | 2 +- content/includes/install-script.md | 3 +- content/includes/open-terminal.md | 3 +- content/includes/root-errors.md | 3 +- content/includes/swarm-compose-compat.md | 4 +- content/includes/swarm-mode.md | 4 +- content/includes/tax-compliance.md | 3 +- content/language/cpp/deploy.md | 2 +- content/language/dotnet/_index.md | 2 +- content/language/dotnet/deploy.md | 2 +- content/language/dotnet/develop.md | 2 +- content/language/dotnet/run-tests.md | 2 +- content/language/golang/_index.md | 2 +- content/language/golang/build-images.md | 4 +- content/language/golang/deploy.md | 2 +- content/language/golang/develop.md | 4 +- content/language/golang/run-tests.md | 2 +- content/language/java/_index.md | 2 +- content/language/java/containerize.md | 2 +- content/language/java/deploy.md | 2 +- content/language/nodejs/_index.md | 2 +- content/language/nodejs/deploy.md | 2 +- content/language/nodejs/develop.md | 5 +- content/language/nodejs/run-tests.md | 2 +- content/language/php/_index.md | 2 +- content/language/php/containerize.md | 2 +- content/language/php/deploy.md | 2 +- content/language/php/develop.md | 4 +- content/language/php/run-tests.md | 2 +- content/language/python/deploy.md | 4 +- content/language/python/develop.md | 2 +- content/language/r/develop.md | 2 +- content/language/ruby/deploy.md | 2 +- content/language/ruby/develop.md | 2 +- content/language/rust/_index.md | 2 +- content/language/rust/deploy.md | 2 +- content/scout/explore/analysis.md | 8 +-- content/scout/explore/dashboard.md | 2 +- content/scout/explore/exceptions.md | 2 +- content/scout/explore/metrics-exporter.md | 5 +- content/scout/guides/vex.md | 2 +- content/scout/install.md | 2 +- content/scout/integrations/ci/gha.md | 2 +- content/scout/integrations/ci/jenkins.md | 2 +- .../integrations/code-quality/sonarqube.md | 2 +- .../scout/integrations/environment/_index.md | 2 +- .../scout/integrations/environment/sysdig.md | 5 +- content/scout/integrations/registry/acr.md | 5 +- .../integrations/registry/artifactory.md | 6 +-- content/scout/integrations/registry/ecr.md | 5 +- .../integrations/team-collaboration/slack.md | 2 +- content/scout/policy/_index.md | 4 +- content/scout/policy/ci.md | 2 +- content/scout/quickstart.md | 5 +- content/scout/release-notes/cli.md | 4 +- content/security/for-admins/domain-audit.md | 6 +-- .../for-admins/enforce-sign-in/_index.md | 1 - .../for-admins/enforce-sign-in/methods.md | 12 ++--- .../for-admins/hardened-desktop/_index.md | 2 +- .../hardened-desktop/air-gapped-containers.md | 3 +- .../enhanced-container-isolation/_index.md | 13 ++--- .../enhanced-container-isolation/config.md | 7 ++- .../features-benefits.md | 4 +- .../how-eci-works.md | 2 +- .../image-access-management.md | 2 +- .../registry-access-management.md | 2 +- .../settings-management/configure.md | 4 +- .../for-admins/provisioning/group-mapping.md | 7 +-- .../for-admins/provisioning/just-in-time.md | 5 +- .../security/for-admins/provisioning/scim.md | 8 ++- .../single-sign-on/configure/configure-idp.md | 12 ++--- .../single-sign-on/manage/_index.md | 2 +- content/security/for-developers/2fa/_index.md | 2 +- .../for-developers/2fa/disable-2fa.md | 3 +- .../for-developers/2fa/new-recovery-code.md | 2 +- .../for-developers/2fa/recover-hub-account.md | 2 +- .../security/for-developers/access-tokens.md | 7 ++- content/security/security-announcements.md | 3 +- .../subscription/build-cloud/manage-seats.md | 2 +- .../core-subscription/add-seats.md | 1 - .../core-subscription/downgrade.md | 4 +- .../core-subscription/remove-seats.md | 1 - .../subscription/core-subscription/upgrade.md | 5 +- content/subscription/desktop-license.md | 5 +- content/trusted-content/insights-analytics.md | 9 ++-- .../trusted-content/official-images/_index.md | 2 +- hugo_stats.json | 10 +++- layouts/shortcodes/admin-domains.html | 5 +- layouts/shortcodes/admin-registry-access.html | 7 ++- layouts/shortcodes/admin-sso-config.md | 5 +- layouts/shortcodes/admin-sso-connect.md | 6 +-- .../shortcodes/admin-sso-management-users.md | 3 +- 473 files changed, 857 insertions(+), 1191 deletions(-) diff --git a/content/accounts/_index.md b/content/accounts/_index.md index 51adeec984..b5857a05e4 100644 --- a/content/accounts/_index.md +++ b/content/accounts/_index.md @@ -29,4 +29,4 @@ You can create a Docker account to secure a Docker ID, which is a username for y In this section, explore how you can create, manage, or update your account. -{{< grid >}} \ No newline at end of file +{{< grid >}} diff --git a/content/accounts/create-account.md b/content/accounts/create-account.md index 7786994be3..9a6af48ab5 100644 --- a/content/accounts/create-account.md +++ b/content/accounts/create-account.md @@ -12,10 +12,9 @@ You can create a free Docker account with your email address or by signing up wi Your Docker ID becomes your username for hosted Docker services, and [Docker forums](https://forums.docker.com/). -> **Tip** +> [!TIP] > > Explore [Docker's core subscriptions](https://www.docker.com/pricing/) to see what else Docker can offer you. -{ .tip } ## Create a Docker ID @@ -37,16 +36,15 @@ Your Docker ID becomes your username for hosted Docker services, and [Docker for 6. Verify your email address to complete the registration process. -> **Note** +> [!NOTE] > > You have limited actions available until you verify your email address. ### Sign up with Google or GitHub -> **Important** +> [!IMPORTANT] > > To sign up with your social provider, make sure you verify your email address with your provider before you begin. -{ .important } 1. Go to the [Docker sign-up page](https://app.docker.com/signup/). @@ -68,20 +66,18 @@ Once you register and verify your Docker ID email address, you can sign in to [y You can also sign in through the CLI using the `docker login` command. For more information, see [`docker login`](../reference/cli/docker/login.md). -> **Warning** +> [!WARNING] > > When you use the `docker login` command, your credentials are stored in your home directory in `.docker/config.json`. The password is base64-encoded in this file. > > We recommend using one of the [Docker credential helpers](https://github.com/docker/docker-credential-helpers) for secure storage of passwords. For extra security, you can also use a [personal access token](../security/for-developers/access-tokens.md) to log in instead, which is still encoded in this file (without a Docker credential helper) but doesn't allow admin actions (such as changing the password). -{ .warning } ### Sign in with your social provider -> **Important** +> [!IMPORTANT] > > To sign in with your social provider, make sure you verify your email address with your provider before you begin. -{ .important } Optionally, you can sign in to an existing Docker account with your Google or GitHub account. If a Docker account exists with the same email address as the primary email for your social provider, your Docker account will automatically be linked to the social profile. This lets you sign in with your social provider. diff --git a/content/accounts/deactivate-user-account.md b/content/accounts/deactivate-user-account.md index 51e7ff2415..0bbfc97f69 100644 --- a/content/accounts/deactivate-user-account.md +++ b/content/accounts/deactivate-user-account.md @@ -9,7 +9,6 @@ You can deactivate an account at any time. This section describes the prerequisi >**Warning** > > All Docker products and services that use your Docker account will be inaccessible after deactivating your account. -{ .warning } ## Prerequisites @@ -38,13 +37,12 @@ Before deactivating your Docker account, ensure that you meet the following requ Once you have completed all the previous steps, you can deactivate your account. -> **Warning** +> [!WARNING] > > This cannot be undone. Be sure you've gathered all the data you need from your account before deactivating it. -{ .warning } 1. Sign in to your [Docker account](https://app.docker.com/login). 2. In Docker Home, select your avatar in the top-right corner to open the drop-down. 3. Select **Account settings**. 4. In the **Account management** section, select **Deactivate account** to open to deactivate account page. -5. To confirm, select **Deactivate account**. \ No newline at end of file +5. To confirm, select **Deactivate account**. diff --git a/content/accounts/manage-account.md b/content/accounts/manage-account.md index 4fa6258f6f..e74244fcce 100644 --- a/content/accounts/manage-account.md +++ b/content/accounts/manage-account.md @@ -6,10 +6,9 @@ title: Manage your Docker account You can centrally manage the settings for your Docker account. Here you can also take administrative actions for your account and manage your account security. -> **Tip** +> [!TIP] > > If your account is associated with an organization that enforces single sign-on (SSO), you may not have permissions to update your account settings. You need to contact your administrator to update your settings. -{ .tip } ## Update general settings @@ -65,4 +64,4 @@ You can take administrative actions for your account in Docker Home. For more information on converting your account, see [Convert an account into an organization](../admin/convert-account.md). -For information on deactivating your account, see [Deactivating a user account](./deactivate-user-account.md). \ No newline at end of file +For information on deactivating your account, see [Deactivating a user account](./deactivate-user-account.md). diff --git a/content/admin/_index.md b/content/admin/_index.md index e352daa8a8..64564e6e76 100644 --- a/content/admin/_index.md +++ b/content/admin/_index.md @@ -44,4 +44,4 @@ The Docker Admin Console is available in [Early Access](../release-lifecycle.md# - Team: A team is a group of Docker members that belong to an organization. Organization and company owners can group members into additional teams to configure repository permissions on a per-team basis. Using teams to group members is optional. - Member: A member is a Docker user that's a member of an organization. Organization and company owners can assign roles to members to define their permissions. -{{< grid >}} \ No newline at end of file +{{< grid >}} diff --git a/content/admin/company/_index.md b/content/admin/company/_index.md index 8ad844d03c..69e17ada95 100644 --- a/content/admin/company/_index.md +++ b/content/admin/company/_index.md @@ -45,4 +45,4 @@ aliases: Learn how to administer a company in the following sections. -{{< grid >}} \ No newline at end of file +{{< grid >}} diff --git a/content/admin/company/new-company.md b/content/admin/company/new-company.md index 4e5a4287ba..fc966bc192 100644 --- a/content/admin/company/new-company.md +++ b/content/admin/company/new-company.md @@ -21,10 +21,9 @@ To create a new company: 3. Near the bottom of the **General** tab, select **Create a company**. 4. Enter a unique name for your company, then select **Continue**. - > **Tip** + > [!TIP] > > The name for your company can't be the same as an existing user, organization, or company namespace. - { .tip } 5. Review the company migration details and then select **Create company**. @@ -43,10 +42,9 @@ To create a new company: 3. Select **Create a company**. 4. Enter a unique name for your company, then select **Continue**. - > **Tip** + > [!TIP] > > The name for your company can't be the same as an existing user, organization, or company namespace. - { .tip } 5. Review the company migration details and then select **Create company**. diff --git a/content/admin/company/organizations.md b/content/admin/company/organizations.md index 209daafca4..842a190f4d 100644 --- a/content/admin/company/organizations.md +++ b/content/admin/company/organizations.md @@ -20,14 +20,12 @@ You can manage the organizations in a company in Docker Hub and the Docker Admin >**Important** > > You must be a company owner to add an organization to a company. You must also be an organization owner of the organization you want to add. -{ .important } There is no limit to the number of organizations you can have under a company layer. All organizations must have a Business subscription. >**Important** > > Once you add an organization to a company, you can't remove it from the company. -{ .important } 1. In Docker Hub, select **Organizations**. 2. Select your company. @@ -60,14 +58,12 @@ When you have a [self-serve](../../subscription/core-subscription/details.md#sel >**Important** > > You must be a company owner to add an organization to a company. You must also be an organization owner of the organization you want to add. -{ .important } There is no limit to the number of organizations you can have under a company layer. All organizations must have a Business subscription. >**Important** > > Once you add an organization to a company, you can't remove it from the company. -{ .important } 1. Sign in to the [Admin Console](https://admin.docker.com). 2. In the left navigation, select your company in the drop-down menu. diff --git a/content/admin/company/owners.md b/content/admin/company/owners.md index 2bd502767c..6447a567d9 100644 --- a/content/admin/company/owners.md +++ b/content/admin/company/owners.md @@ -50,4 +50,4 @@ Once you've added the new owner, you can view the user in the **Company owners** 5. Select **Remove as company owner**. {{< /tab >}} -{{< /tabs >}} \ No newline at end of file +{{< /tabs >}} diff --git a/content/admin/convert-account.md b/content/admin/convert-account.md index aba1356cbd..2016727a2c 100644 --- a/content/admin/convert-account.md +++ b/content/admin/convert-account.md @@ -10,10 +10,9 @@ You can convert an existing user account to an organization. This is useful if y When you convert a user account to an organization, the account is migrated to a Docker Team plan. -> **Important** +> [!IMPORTANT] > > Once you convert your account to an organization, you can’t revert it to a user account. -{ .important } ## Prerequisites diff --git a/content/admin/deactivate-account.md b/content/admin/deactivate-account.md index 2092cf328b..a0cfc5d8c8 100644 --- a/content/admin/deactivate-account.md +++ b/content/admin/deactivate-account.md @@ -11,7 +11,6 @@ You can deactivate an account at any time. This section describes the prerequisi >**Warning** > > All Docker products and services that use your Docker account or organization account will be inaccessible after deactivating your account. -{ .warning } ## Prerequisites @@ -32,10 +31,9 @@ Before deactivating an organization, complete the following: Once you have completed all the previous steps, you can deactivate your organization. -> **Warning** +> [!WARNING] > > This cannot be undone. Be sure you've gathered all the data you need from your organization before deactivating it. -{ .warning } {{< tabs >}} {{< tab name="Admin Console" >}} diff --git a/content/admin/organization/activity-logs.md b/content/admin/organization/activity-logs.md index 0c471d0444..ef6d720263 100644 --- a/content/admin/organization/activity-logs.md +++ b/content/admin/organization/activity-logs.md @@ -17,7 +17,7 @@ For example, activity logs display activities such as the date when a repository Owners can also see the activity logs for their repository if the repository is part of the organization subscribed to a Docker Business or Team plan. -> **Note** +> [!NOTE] > > Activity logs requires a [Docker Team or Business subscription](../../../subscription/_index.md). diff --git a/content/admin/organization/manage-a-team.md b/content/admin/organization/manage-a-team.md index 6739e4c74e..88a551ecc9 100644 --- a/content/admin/organization/manage-a-team.md +++ b/content/admin/organization/manage-a-team.md @@ -99,7 +99,7 @@ you automatically have "Read-only" permissions: | Trigger Builds | ❌ | ✅ | ✅ | | Edit Build Settings | ❌ | ❌ | ✅ | -> **Note** +> [!NOTE] > > A user who hasn't verified their email address only has > `Read-only` access to the repository, regardless of the rights their team diff --git a/content/admin/organization/members.md b/content/admin/organization/members.md index 495393d958..17edee17d3 100644 --- a/content/admin/organization/members.md +++ b/content/admin/organization/members.md @@ -40,12 +40,12 @@ To add a member to a team: 2. Select **Organizations**, your organization, and then **Members**. 3. Select the **Action** icon, and then select **Add to team**. - > **Note** + > [!NOTE] > > You can also navigate to **Organizations** > **Your Organization** > **Teams** > **Your Team Name** and select **Add Member**. Select a member from the drop-down list to add them to the team or search by Docker ID or email. 4. Select the team and then select **Add**. - > **Note** + > [!NOTE] > > An invitee must first accept the invitation to join the organization before being added to the team. @@ -60,7 +60,7 @@ To add a member to a team: 2. Select the team name. 3. Select **Add member**. You can add the member by searching for their email address or username. - > **Note** + > [!NOTE] > > An invitee must first accept the invitation to join the organization before being added to the team. diff --git a/content/admin/organization/orgs.md b/content/admin/organization/orgs.md index ac6d8d15fd..110e1fe536 100644 --- a/content/admin/organization/orgs.md +++ b/content/admin/organization/orgs.md @@ -30,7 +30,7 @@ To create an organization: [Docker Pricing](https://www.docker.com/pricing/) for details on the features offered in the Team and Business plan. - > **Note** + > [!NOTE] > > Selecting **Buy Now** isn't an obligation to pay. You can complete > this step without incurring a payment. @@ -39,7 +39,7 @@ for details on the features offered in the Team and Business plan. your organization in Docker Hub. It's not possible to change the name of the organization after you've created it. - > **Note** + > [!NOTE] > > You can't use the same name for the organization and your Docker ID. If you want to use your Docker ID as the organization name, then you must first [convert your account into an organization](../convert-account.md). @@ -63,7 +63,7 @@ To view an organization: 1. Sign in to Docker Hub with a user account that is a member of any team in the organization. - > **Note** + > [!NOTE] > > You can't _directly_ log in to an organization. This is especially > important to note if you create an organization by @@ -114,11 +114,10 @@ If you have multiple organizations that you want to merge into one, complete the 3. Manually move over your data, including all repositories. 4. Once you're done moving all of your users and data, [downgrade](../../subscription/core-subscription/downgrade.md) the secondary account to a free subscription. -> **Tip** +> [!TIP] > > If your organization has a Docker Core Business subscription with a purchase order, contact Support or your Account Manager at Docker. > -{ .tip } ## More resources diff --git a/content/billing/3d-secure.md b/content/billing/3d-secure.md index 6bad0609bd..71ebd4889e 100644 --- a/content/billing/3d-secure.md +++ b/content/billing/3d-secure.md @@ -4,7 +4,7 @@ description: Learn about 3D Secure support for Docker billing. keywords: billing, renewal, payments, subscriptions --- -> **Note** +> [!NOTE] > > [Docker Core subscription](/billing/core-billing/get-started-core/) payments support 3D secure authentication. @@ -25,7 +25,6 @@ If you encounter errors completing payments due to 3DS, you can troubleshoot in 2. Contact your bank to determine any errors on their end. 3. Try a different payment method that doesn’t require 3DS. -> **Tip** +> [!TIP] > > Make sure you allow third-party scripts in your browser and that any ad blocker you may use is disabled when attempting to complete payments. -{ .tip } diff --git a/content/billing/build-billing.md b/content/billing/build-billing.md index 71ff1d164e..9b47146435 100644 --- a/content/billing/build-billing.md +++ b/content/billing/build-billing.md @@ -8,10 +8,9 @@ Build Cloud is a next-gen build tool that enables improved build speed, a shared If you don’t have a Docker Core subscription, you can buy Docker Build Cloud Team and create a team in Docker Build Cloud. -> **Tip** +> [!TIP] > > You can create a free Docker Personal account and [try Docker Build Cloud for free](/subscription/build-cloud/build-details#docker-personal). Team benefits aren't included. -{ .tip } In this section, learn how to set up and manage billing for your Build Cloud subscription. For more information about the subscription tiers, see [Build Cloud subscriptions and features](/subscription/build-cloud/build-details). To buy Docker Build Cloud Business, [contact sales](https://www.docker.com/products/build-cloud/#contact_sales). @@ -33,7 +32,7 @@ Subscription renewals charge to the default payment method. You can buy a Docker Build Cloud Team subscription if you haven’t created an organization yet. To do so, you can create a team in Docker Build Cloud. -> **Note** +> [!NOTE] > > To create a new organization and start a Docker Build Cloud Team subscription, you need a personal Docker account. You can [sign up](https://hub.docker.com/signup) for free. diff --git a/content/billing/core-billing/cycle.md b/content/billing/core-billing/cycle.md index 0c52849bb3..7096a6d421 100644 --- a/content/billing/core-billing/cycle.md +++ b/content/billing/core-billing/cycle.md @@ -26,7 +26,7 @@ When you change the billing cycle's duration: ## Organization -> **Note** +> [!NOTE] > > You must be an organization owner to make changes to the payment information. diff --git a/content/billing/core-billing/details.md b/content/billing/core-billing/details.md index f39cab903e..b717a9fd20 100644 --- a/content/billing/core-billing/details.md +++ b/content/billing/core-billing/details.md @@ -10,10 +10,9 @@ aliases: You can update the billing information for your personal account or for an organization. When you update your billing information, these changes apply to future billing invoices. -> **Important** +> [!IMPORTANT] > > You can't update an existing invoice, including paid and unpaid invoices. -{ .important } The billing information provided appears on all your billing invoices. The email address provided is where Docker sends all invoices and other [billing-related communication](#update-your-email-address-that-receives-billing-invoices). @@ -29,7 +28,7 @@ The billing information provided appears on all your billing invoices. The email ### Organization -> **Note** +> [!NOTE] > > You must be an organization owner to make changes to the billing information. diff --git a/content/billing/core-billing/history.md b/content/billing/core-billing/history.md index ac6d7b46f5..8ffd74bc18 100644 --- a/content/billing/core-billing/history.md +++ b/content/billing/core-billing/history.md @@ -69,7 +69,7 @@ From here you can download an invoice. ### Organization -> **Note** +> [!NOTE] > > You must be an owner of the organization to view the billing history. diff --git a/content/billing/core-billing/payment-method.md b/content/billing/core-billing/payment-method.md index f108aca15b..e665dbef8b 100644 --- a/content/billing/core-billing/payment-method.md +++ b/content/billing/core-billing/payment-method.md @@ -42,7 +42,7 @@ All currency, for example the amount listed on your billing invoice, is in Unite ### Organization -> **Note** +> [!NOTE] > > You must be an organization owner to make changes to the payment information. diff --git a/content/billing/scout-billing.md b/content/billing/scout-billing.md index ba2572018e..f5b11b5fef 100644 --- a/content/billing/scout-billing.md +++ b/content/billing/scout-billing.md @@ -8,7 +8,7 @@ Docker Scout lets users secure their software supply chain and continuously obse In this section, learn how to buy and manage a Docker Scout Team subscription for your personal account or for an organization. If you're an organization with multiple teams, a Docker Scout Business plan may be better. To buy Docker Scout Business, [contact sales](https://www.docker.com/products/docker-scout/#contact-sales). -> **Note** +> [!NOTE] > > You need to be an owner to manage billing for an organization. > @@ -57,7 +57,7 @@ To remove repositories: The number of repositories updates on your next billing cycle. -> **Note** +> [!NOTE] > > You can't add repositories while repository removal is pending. You can add repositories again during the next billing cycle. > @@ -66,11 +66,10 @@ The number of repositories updates on your next billing cycle. You can downgrade from Docker Scout Team or Docker Scout Business to a Docker Scout Free subscription at anytime before the renewal date. Your subscription features remain available until the end of your billing cycle. -> **Tip** +> [!TIP] > > To downgrade from Docker Scout Business to Docker Scout Team, [contact](https://hub.docker.com/support/contact) your account manager to cancel so you can start a Docker Scout Team subscription. > -{ .tip } 1. Go to [Billing settings](https://scout.docker.com/settings/billing) in the Docker Scout Dashboard. 2. Find your Docker Scout plan, then select **Change plan**. diff --git a/content/billing/tax-certificate.md b/content/billing/tax-certificate.md index c21785c50d..0358b3c0ce 100644 --- a/content/billing/tax-certificate.md +++ b/content/billing/tax-certificate.md @@ -32,10 +32,9 @@ Palo Alto, CA 94306 2. Enter the required information. 3. In the **Additional Information** field, list the Docker ID/namespace(s) of the accounts that you want to apply the tax exemption certificate to. - > **Tip** + > [!TIP] > > You can list multiple namespaces that share the same tax exemption certificate, if applicable. - { .tip } 4. Add the tax certificate from your system by dragging and dropping them onto the file area, or select the **Browse Files** button to open a file dialog. 5. Select **Submit**. diff --git a/content/build-cloud/_index.md b/content/build-cloud/_index.md index 4d945fce68..d78537141d 100644 --- a/content/build-cloud/_index.md +++ b/content/build-cloud/_index.md @@ -40,7 +40,7 @@ isolated to a single Amazon EC2 instance, with a dedicated EBS volume for build cache, and encryption in transit. That means there are no shared processes or data between cloud builders. -> **Note** +> [!NOTE] > > Docker Build Cloud is currently only available in the US East region. Users > in Europe and Asia may experience increased latency compared to users based diff --git a/content/build-cloud/ci.md b/content/build-cloud/ci.md index aa54803551..cfda154337 100644 --- a/content/build-cloud/ci.md +++ b/content/build-cloud/ci.md @@ -25,7 +25,7 @@ build cache or build without tagging the image. When you use Docker Build Cloud, Buildx automatically loads the build result if you build a tagged image. See [Loading build results](./usage/#loading-build-results) for details. -> **Note** +> [!NOTE] > > Builds on Docker Build Cloud have a timeout limit of two hours. Builds that > run for longer than two hours are automatically cancelled. @@ -33,7 +33,7 @@ See [Loading build results](./usage/#loading-build-results) for details. {{< tabs >}} {{< tab name="GitHub Actions" >}} -> **Note** +> [!NOTE] > > Version 4.0.0 and later of `docker/build-push-action` and > `docker/bake-action` builds images with [provenance attestations by diff --git a/content/build-cloud/usage.md b/content/build-cloud/usage.md index 117cd5421a..4403a660e2 100644 --- a/content/build-cloud/usage.md +++ b/content/build-cloud/usage.md @@ -54,7 +54,7 @@ buildx build`, without discrepancies. To build with Docker Build Cloud using `docker compose build`, first set the cloud builder as your selected builder, then run your build. -> **Note** +> [!NOTE] > > Make sure you're using a supported version of Docker Compose, see > [Prerequisites](setup.md#prerequisites). @@ -138,14 +138,13 @@ such as authentication credentials or tokens, use the `--secret` and `--ssh` CLI flags for the `docker buildx` command. The traffic is encrypted and secrets are never stored in the build cache. -> **Warning** +> [!WARNING] > > If you're misusing build arguments to pass credentials, authentication > tokens, or other secrets, you should refactor your build to pass the secrets using > [secret mounts](/reference/cli/docker/buildx/build.md#secret) instead. > Build arguments are stored in the cache and their values are exposed through attestations. > Secret mounts don't leak outside of the build and are never included in attestations. -{.warning} For more information, refer to: @@ -165,11 +164,10 @@ To clear the builder's cache manually, use the [`docker buildx prune` command](/reference/cli/docker/buildx/prune/). This works like pruning the cache for any other builder. -> **Warning** +> [!WARNING] > > Pruning a cloud builder's cache also removes the cache for other team members > using the same builder. -{ .warning } ## Unset Docker Build Cloud as the default builder @@ -196,4 +194,3 @@ including OCI registries, must be accessible over the internet. >We are currently testing an experimental feature which lets cloud builders access internal resources. > > If you're interested in trying this feature, contact us using the [Support form](https://hub.docker.com/support/contact?topic=Docker+Build+Cloud&subject=Private+registry+access). -{ .tip } diff --git a/content/build/attestations/_index.md b/content/build/attestations/_index.md index 1f57d61818..3e05424c10 100644 --- a/content/build/attestations/_index.md +++ b/content/build/attestations/_index.md @@ -47,7 +47,7 @@ You can opt in to add either the SBOM or provenance attestation type, or both. $ docker buildx build --sbom=true --provenance=true . ``` -> **Note** +> [!NOTE] > > The default image store doesn't support attestations. If you're using the > default image store and you build an image using the default `docker` driver, @@ -60,7 +60,7 @@ $ docker buildx build --sbom=true --provenance=true . > a registry directly. > - Enable the [containerd image store](../../desktop/containerd.md). -> **Note** +> [!NOTE] > > Provenance attestations are enabled by default, with the `mode=min` option. > You can disable provenance attestations using the `--provenance=false` flag, diff --git a/content/build/attestations/sbom.md b/content/build/attestations/sbom.md index cf8889702c..243ce977e4 100644 --- a/content/build/attestations/sbom.md +++ b/content/build/attestations/sbom.md @@ -188,10 +188,9 @@ $ docker buildx imagetools inspect /: \ } ``` -> **Tip** +> [!TIP] > > If the image is multi-platform, you can check the SBOM for a platform-specific index using `--format '{{ json (index .SBOM "linux/amd64").SPDX }}'`. -{ .tip } You can also construct more complex expressions using the full functionality of Go templates. For example, you can list all the installed packages and their @@ -223,11 +222,10 @@ an image that implements the $ docker buildx build --attest type=sbom,generator= . ``` -> **Tip** +> [!TIP] > > The Docker Scout SBOM generator is available. See > [Docker Scout SBOMs](/scout/how-tos/view-create-sboms.md). -{ .tip } ## SBOM attestation example diff --git a/content/build/attestations/slsa-provenance.md b/content/build/attestations/slsa-provenance.md index 0de3647f74..e6b5fac985 100644 --- a/content/build/attestations/slsa-provenance.md +++ b/content/build/attestations/slsa-provenance.md @@ -138,7 +138,7 @@ well as: When possible, you should prefer `mode=max` as it contains significantly more detailed information for analysis. -> **Warning** +> [!WARNING] > > Note that `mode=max` exposes the values of > [build arguments](../../reference/cli/docker/buildx/build.md#build-arg). @@ -147,7 +147,6 @@ detailed information for analysis. > tokens, or other secrets, you should refactor your build to pass the secrets using > [secret mounts](../../reference/cli/docker/buildx/build.md#secret) instead. > Secret mounts don't leak outside of the build and are never included in provenance attestations. -{.warning} ## Inspecting Provenance diff --git a/content/build/bake/compose-file.md b/content/build/bake/compose-file.md index a139df0851..5af1f5a960 100644 --- a/content/build/bake/compose-file.md +++ b/content/build/bake/compose-file.md @@ -120,7 +120,7 @@ $ docker buildx bake --print } ``` -> **Note** +> [!NOTE] > > System environment variables take precedence over environment variables > in `.env` file. diff --git a/content/build/building/annotations.md b/content/build/building/annotations.md index 114de3d5a2..4ac9f4a45d 100644 --- a/content/build/building/annotations.md +++ b/content/build/building/annotations.md @@ -36,7 +36,7 @@ Annotations are not to be confused with [attestations]: You can add annotations to an image at build-time, or when creating the image manifest or index. -> **Note** +> [!NOTE] > > The Docker Engine image store doesn't support loading images with > annotations. To build with annotations, make sure to push the image directly diff --git a/content/build/building/best-practices.md b/content/build/building/best-practices.md index dda2fa21d4..7516d3ab0d 100644 --- a/content/build/building/best-practices.md +++ b/content/build/building/best-practices.md @@ -460,7 +460,7 @@ build from inadvertently succeeding. For example: RUN set -o pipefail && wget -O - https://some.site | wc -l > /number ``` -> **Note** +> [!NOTE] > > Not all shells support the `-o pipefail` option. > @@ -743,7 +743,7 @@ like the following example: RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres ``` -> **Note** +> [!NOTE] > > Consider an explicit UID/GID. > @@ -751,7 +751,7 @@ RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres > the "next" UID/GID is assigned regardless of image rebuilds. So, if it’s > critical, you should assign an explicit UID/GID. -> **Note** +> [!NOTE] > > Due to an [unresolved bug](https://github.com/golang/go/issues/13548) in the > Go archive/tar package's handling of sparse files, attempting to create a user diff --git a/content/build/building/context.md b/content/build/building/context.md index 9b47bc9c5e..bf5a8e788b 100644 --- a/content/build/building/context.md +++ b/content/build/building/context.md @@ -288,7 +288,7 @@ $ GIT_AUTH_TOKEN= docker buildx build \ https://github.com/user/private.git ``` -> **Note** +> [!NOTE] > > Don't use `--build-arg` for secrets. @@ -512,7 +512,7 @@ A preprocessing step uses Go's to trim whitespace and remove `.` and `..`. Lines that are blank after preprocessing are ignored. -> **Note** +> [!NOTE] > > For historical reasons, the pattern `.` is ignored. diff --git a/content/build/building/multi-platform.md b/content/build/building/multi-platform.md index 523e8224f9..93f21cf1bc 100644 --- a/content/build/building/multi-platform.md +++ b/content/build/building/multi-platform.md @@ -72,7 +72,7 @@ automatically detects the secondary architectures that are available. When BuildKit needs to run a binary for a different architecture, it automatically loads it through a binary registered in the `binfmt_misc` handler. -> **Note** +> [!NOTE] > > Emulation with QEMU can be much slower than native builds, especially for > compute-heavy tasks like compilation and compression or decompression. @@ -258,7 +258,7 @@ $ docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t **Note** +> [!NOTE] > > * `` must be a valid Docker ID and `` and valid repository on > Docker Hub. diff --git a/content/build/building/packaging.md b/content/build/building/packaging.md index 77cad11a31..d6b92ef880 100644 --- a/content/build/building/packaging.md +++ b/content/build/building/packaging.md @@ -42,7 +42,7 @@ Refer to the [`docker build` CLI reference](../../reference/cli/docker/buildx/build.md#file) to learn about the `--file` flag. -> **Note** +> [!NOTE] > > We recommend using the default (`Dockerfile`) for your project's primary > Dockerfile. @@ -122,12 +122,11 @@ your Dockerfile, and should be the first line in Dockerfiles. # syntax=docker/dockerfile:1 ``` -> **Tip** +> [!TIP] > > We recommend using `docker/dockerfile:1`, which always points to the latest > release of the version 1 syntax. BuildKit automatically checks for updates of > the syntax before building, making sure you are using the most current version. -{ .tip } ### Base image @@ -168,7 +167,7 @@ Dockerfiles begin with the `#` symbol. As your Dockerfile evolves, comments can be instrumental to document how your Dockerfile works for any future readers and editors of the file, including your future self! -> **Note** +> [!NOTE] > > You might've noticed that comments are denoted using the same symbol as the > [syntax directive](#dockerfile-syntax) on the first line of the file. diff --git a/content/build/building/variables.md b/content/build/building/variables.md index b2241f5988..5b179895ee 100644 --- a/content/build/building/variables.md +++ b/content/build/building/variables.md @@ -11,14 +11,13 @@ In Docker Build, build arguments (`ARG`) and environment variables (`ENV`) both serve as a means to pass information into the build process. You can use them to parameterize the build, allowing for more flexible and configurable builds. -> **Warning** +> [!WARNING] > > Build arguments and environment variables are inappropriate for passing secrets > to your build, because they're exposed in the final image. Instead, use > secret mounts or SSH mounts, which expose secrets to your builds securely. > > See [Build secrets](./secrets.md) for more information. -{ .warning } ## Similarities and differences diff --git a/content/build/buildkit/_index.md b/content/build/buildkit/_index.md index 8bbdfddfa4..580c25cc82 100644 --- a/content/build/buildkit/_index.md +++ b/content/build/buildkit/_index.md @@ -86,7 +86,7 @@ command, run: $ DOCKER_BUILDKIT=1 docker build . ``` -> **Note** +> [!NOTE] > > [Buildx](../architecture.md#buildx) always uses BuildKit. @@ -107,12 +107,11 @@ daemon. ## BuildKit on Windows -> **Warning** +> [!WARNING] > > BuildKit only fully supports building Linux containers. > Windows container support is experimental, and is tracked in > [`moby/buildkit#616`](https://github.com/moby/buildkit/issues/616). -{ .warning } BuildKit has experimental support for Windows containers (WCOW) as of version 0.13. This section walks you through the steps for trying it out. @@ -133,7 +132,7 @@ We appreciate any feedback you submit by [opening an issue here](https://github. ### Steps -> **Note** +> [!NOTE] > > The following commands require administrator (elevated) privileges in a PowerShell terminal. @@ -188,7 +187,7 @@ We appreciate any feedback you submit by [opening an issue here](https://github. 7. In another terminal with administrator privileges, create a remote builder that uses the local BuildKit daemon. - > **Note** + > [!NOTE] > > This requires Docker Desktop version 4.29 or later. diff --git a/content/build/buildkit/configure.md b/content/build/buildkit/configure.md index 88ee8c909a..f64c01b389 100644 --- a/content/build/buildkit/configure.md +++ b/content/build/buildkit/configure.md @@ -23,7 +23,7 @@ defining a mirror for `docker.io` (Docker Hub) to `mirror.gcr.io`. mirrors = ["mirror.gcr.io"] ``` - > **Note** + > [!NOTE] > > `debug = true` turns on debug requests in the BuildKit daemon, which logs a > message that shows when a mirror is being used. diff --git a/content/build/cache/backends/_index.md b/content/build/cache/backends/_index.md index b13b6b4a0b..58d28e4169 100644 --- a/content/build/cache/backends/_index.md +++ b/content/build/cache/backends/_index.md @@ -21,14 +21,13 @@ The default `docker` driver supports the `inline`, `local`, `registry`, and `gha` cache backends, but only if you have enabled the [containerd image store](/desktop/containerd.md). Other cache backends require you to select a different [driver](../../drivers/_index.md). -> **Warning** +> [!WARNING] > > If you use secrets or credentials inside your build process, ensure you > manipulate them using the dedicated > [`--secret` option](../../../reference/cli/docker/buildx/build.md#secret). > Manually managing secrets using `COPY` or `ARG` could result in leaked > credentials. -{ .warning } ## Backends @@ -73,7 +72,7 @@ $ docker buildx build --push -t / \ --cache-from type=registry,ref=/[,parameters...] . ``` -> **Warning** +> [!WARNING] > > As a general rule, each cache writes to some location. No location can be > written to twice, without overwriting the previously cached data. If you want diff --git a/content/build/cache/garbage-collection.md b/content/build/cache/garbage-collection.md index bb5ad29934..33297b22fa 100644 --- a/content/build/cache/garbage-collection.md +++ b/content/build/cache/garbage-collection.md @@ -86,7 +86,7 @@ GC Policy rule#3: - `rule#3`: if previous policies were insufficient start deleting internal data to keep build cache under cap. -> **Note** +> [!NOTE] > > `Keep Bytes` defaults to 10% of the size of the disk. If the disk size cannot > be determined, it uses 2GB as a fallback. diff --git a/content/build/ci/github-actions/annotations.md b/content/build/ci/github-actions/annotations.md index 7bbdd310ba..6b3e3f995c 100644 --- a/content/build/ci/github-actions/annotations.md +++ b/content/build/ci/github-actions/annotations.md @@ -152,7 +152,7 @@ jobs: push: true ``` -> **Note** +> [!NOTE] > > The build must produce the components that you want to annotate. For example, > to annotate an image index, the build must produce an index. If the build diff --git a/content/build/ci/github-actions/attestations.md b/content/build/ci/github-actions/attestations.md index 3e619ea907..190cc9832c 100644 --- a/content/build/ci/github-actions/attestations.md +++ b/content/build/ci/github-actions/attestations.md @@ -25,7 +25,7 @@ attestations to your image, with the following conditions: attestations are added to the image. These output formats don't support attestations. -> **Warning** +> [!WARNING] > > If you're using `docker/build-push-action` to build images for code in a > public GitHub repository, the provenance attestations attached to your image @@ -35,7 +35,6 @@ attestations to your image, with the following conditions: > attestation. Refactor your build to pass those secrets using > [secret mounts](../../../reference/cli/docker/buildx/build.md#secret) > instead. Also remember to rotate any secrets you may have exposed. -{ .warning } ## Max-level provenance diff --git a/content/build/ci/github-actions/cache.md b/content/build/ci/github-actions/cache.md index 434b269f70..3479a8c854 100644 --- a/content/build/ci/github-actions/cache.md +++ b/content/build/ci/github-actions/cache.md @@ -6,7 +6,7 @@ keywords: ci, github actions, gha, buildkit, buildx, cache This page contains examples on using the cache storage backends with GitHub Actions. -> **Note** +> [!NOTE] > > See [Cache storage backends](../../cache/backends/_index.md) for more > details about cache storage backends. @@ -209,12 +209,11 @@ For more information about this workaround, refer to the ### Local cache -> **Warning** +> [!WARNING] > > At the moment, old cache entries aren't deleted, so the cache size [keeps growing](https://github.com/docker/build-push-action/issues/252). > The following example uses the `Move cache` step as a workaround (see [`moby/buildkit#1896`](https://github.com/moby/buildkit/issues/1896) > for more info). -{ .warning } You can also leverage [GitHub cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows) using the [actions/cache](https://github.com/actions/cache) and [local cache exporter](../../cache/backends/local.md) diff --git a/content/build/ci/github-actions/multi-platform.md b/content/build/ci/github-actions/multi-platform.md index 818e966775..dde3ebc140 100644 --- a/content/build/ci/github-actions/multi-platform.md +++ b/content/build/ci/github-actions/multi-platform.md @@ -7,7 +7,7 @@ keywords: ci, github actions, gha, buildkit, buildx, multi-platform You can build [multi-platform images](../../building/multi-platform.md) using the `platforms` option, as shown in the following example: -> **Note** +> [!NOTE] > > - For a list of available platforms, see the [Docker Setup Buildx](https://github.com/marketplace/actions/docker-setup-buildx) > action. diff --git a/content/build/ci/github-actions/secrets.md b/content/build/ci/github-actions/secrets.md index 4388f27040..0dda2551ea 100644 --- a/content/build/ci/github-actions/secrets.md +++ b/content/build/ci/github-actions/secrets.md @@ -57,7 +57,7 @@ jobs: "github_token=${{ secrets.GITHUB_TOKEN }}" ``` -> **Note** +> [!NOTE] > > You can also expose a secret file to the build with the `secret-files` input: > @@ -94,7 +94,7 @@ secrets: | | `EMPTYLINE` | `aaaa\n\nbbbb\nccc` | | `JSON_SECRET` | `{"key1":"value1","key2":"value2"}` | -> **Note** +> [!NOTE] > > Double escapes are needed for quote signs. diff --git a/content/build/ci/github-actions/test-before-push.md b/content/build/ci/github-actions/test-before-push.md index 87bcb7ff31..a780e45cf0 100644 --- a/content/build/ci/github-actions/test-before-push.md +++ b/content/build/ci/github-actions/test-before-push.md @@ -56,7 +56,7 @@ jobs: tags: ${{ env.LATEST_TAG }} ``` -> **Note** +> [!NOTE] > > The `linux/amd64` image is only built once in this workflow. The image is > built once, and the following steps use the internal cache from the first diff --git a/content/build/dockerfile/frontend.md b/content/build/dockerfile/frontend.md index 2b4b1b85fd..d73fb8b589 100644 --- a/content/build/dockerfile/frontend.md +++ b/content/build/dockerfile/frontend.md @@ -46,7 +46,7 @@ Custom Dockerfile implementations allow you to: - Use [alternative build definitions, or create your own](https://github.com/moby/buildkit#exploring-llb) - Build your own Dockerfile frontend with custom features -> **Note** +> [!NOTE] > > BuildKit ships with a built-in Dockerfile frontend, but it's recommended > to use an external image to make sure that all users use the same version on diff --git a/content/build/drivers/docker-container.md b/content/build/drivers/docker-container.md index aecdf66c8a..b5fa5550e6 100644 --- a/content/build/drivers/docker-container.md +++ b/content/build/drivers/docker-container.md @@ -122,7 +122,7 @@ $ docker buildx build \ --push . ``` -> **Note** +> [!NOTE] > > Emulation with QEMU can be much slower than native builds, especially for > compute-heavy tasks like compilation and compression or decompression. diff --git a/content/build/drivers/kubernetes.md b/content/build/drivers/kubernetes.md index 6a79f2a95d..124ad370a3 100644 --- a/content/build/drivers/kubernetes.md +++ b/content/build/drivers/kubernetes.md @@ -163,12 +163,11 @@ $ docker buildx build \ --push . ``` -> **Warning** +> [!WARNING] > > QEMU performs full-CPU emulation of non-native platforms, which is much > slower than native builds. Compute-heavy tasks like compilation and > compression/decompression will likely take a large performance hit. -{ .warning } Using a custom BuildKit image or invoking non-native binaries in builds may require that you explicitly turn on QEMU using the `qemu.install` option when @@ -301,7 +300,7 @@ Prerequisites: --driver-opt=namespace=buildkit ``` - > **Note** + > [!NOTE] > > Remember to specify the namespace in driver options. diff --git a/content/build/exporters/_index.md b/content/build/exporters/_index.md index 1eec88192b..df3c1fb3f3 100644 --- a/content/build/exporters/_index.md +++ b/content/build/exporters/_index.md @@ -245,7 +245,7 @@ Use the `force-compression=true` option to force re-compressing layers imported from a previous image, if the requested compression algorithm is different from the previous compression algorithm. -> **Note** +> [!NOTE] > > The `gzip` and `estargz` compression methods use the [`compress/gzip` package](https://pkg.go.dev/compress/gzip), > while `zstd` uses the [`github.com/klauspost/compress/zstd` package](https://github.com/klauspost/compress/tree/master/zstd). diff --git a/content/build/guide/_index.md b/content/build/guide/_index.md index 7cc2e9aca6..9cf7be4da1 100644 --- a/content/build/guide/_index.md +++ b/content/build/guide/_index.md @@ -31,4 +31,4 @@ workflows. You don't need to complete this entire guide from start to finish. Follow the sections that seem relevant to you, and save the advanced sections at the end for later, when you need them. -{{< button text="Get started" url="intro.md" >}} \ No newline at end of file +{{< button text="Get started" url="intro.md" >}} diff --git a/content/compose/_index.md b/content/compose/_index.md index 5de8d1a4ea..0f15b9794d 100644 --- a/content/compose/_index.md +++ b/content/compose/_index.md @@ -62,4 +62,4 @@ well as CI workflows. It also has commands for managing the whole lifecycle of y * Stream the log output of running services * Run a one-off command on a service -{{< grid >}} \ No newline at end of file +{{< grid >}} diff --git a/content/compose/bridge/advanced-integration.md b/content/compose/bridge/advanced-integration.md index 21cfbc3ccf..a4ac5f89b5 100644 --- a/content/compose/bridge/advanced-integration.md +++ b/content/compose/bridge/advanced-integration.md @@ -38,4 +38,4 @@ To use the `compose-bridge` binary as a `kubectl` plugin, you need to make sure $ kubectl compose-bridge [command] ``` -Replace `[command]` with any `compose-bridge` command you want to use. \ No newline at end of file +Replace `[command]` with any `compose-bridge` command you want to use. diff --git a/content/compose/bridge/customize.md b/content/compose/bridge/customize.md index c8b0835eb7..5fddedf868 100644 --- a/content/compose/bridge/customize.md +++ b/content/compose/bridge/customize.md @@ -185,4 +185,4 @@ to the Compose Bridge transformation contract. ## What's next? -- [Explore the advanced integration](advanced-integration.md) \ No newline at end of file +- [Explore the advanced integration](advanced-integration.md) diff --git a/content/compose/bridge/usage.md b/content/compose/bridge/usage.md index 742ed2f376..64c21173f6 100644 --- a/content/compose/bridge/usage.md +++ b/content/compose/bridge/usage.md @@ -60,7 +60,7 @@ These files are then stored within your project in the `/out` folder. The Kubernetes manifests can then be used to run the application on Kubernetes using the standard deployment command `kubectl apply -k out/overlays/desktop/`. -> **Note** +> [!NOTE] > > Make sure you have enabled Kubernetes in Docker Desktop before you deploy your Compose Bridge transformations. @@ -70,12 +70,11 @@ If you want to convert a `compose.yaml` file that is located in another director $ compose-bridge convert -f /compose.yaml ``` -> **Tip** +> [!TIP] > > Run `compose-bridge convert --help` to see all available flags. -{ .tip } ## What's next? - [Explore how you can customize Compose Bridge](customize.md) -- [Explore the advanced integration](advanced-integration.md) \ No newline at end of file +- [Explore the advanced integration](advanced-integration.md) diff --git a/content/compose/compose-application-model.md b/content/compose/compose-application-model.md index 63e7494cf6..3bb26a27c6 100644 --- a/content/compose/compose-application-model.md +++ b/content/compose/compose-application-model.md @@ -162,4 +162,4 @@ example-backend-1 example/database "docker-entrypoint.s…" backend - [Quickstart](gettingstarted.md) - [Explore some sample applications](samples-for-compose.md) -- [Familiarize yourself with the Compose Specification](compose-file/_index.md) \ No newline at end of file +- [Familiarize yourself with the Compose Specification](compose-file/_index.md) diff --git a/content/compose/compose-file/04-version-and-name.md b/content/compose/compose-file/04-version-and-name.md index 2f7fbed695..9d526b4418 100644 --- a/content/compose/compose-file/04-version-and-name.md +++ b/content/compose/compose-file/04-version-and-name.md @@ -32,4 +32,4 @@ services: command: echo "I'm running ${COMPOSE_PROJECT_NAME}" ``` -For more information on other ways to name Compose projects, see [Specify a project name](../project-name.md). \ No newline at end of file +For more information on other ways to name Compose projects, see [Specify a project name](../project-name.md). diff --git a/content/compose/compose-file/05-services.md b/content/compose/compose-file/05-services.md index 950b1d90b6..ef93cd695b 100644 --- a/content/compose/compose-file/05-services.md +++ b/content/compose/compose-file/05-services.md @@ -723,7 +723,7 @@ expose: - "8080-8085/tcp" ``` -> **Note** +> [!NOTE] > > If the Dockerfile for the image already exposes ports, it is visible to other containers on the network even if `expose` is not set in your Compose file. @@ -1173,7 +1173,7 @@ are platform specific. Driver specific options can be set with `options` as key- `mac_address` sets a MAC address for the service container. -> **Note** +> [!NOTE] > Container runtimes might reject this value (ie. Docker Engine >= v25.0). In that case, you should use [networks.mac_address](#mac_address) instead. ### mem_limit @@ -1248,7 +1248,7 @@ network can use either the service name or an alias to connect to one of the ser Since `aliases` are network-scoped, the same service can have different aliases on different networks. -> **Note** +> [!NOTE] > A network-wide alias can be shared by multiple containers, and even by multiple services. > If it is, then exactly which container the name resolves to is not guaranteed. @@ -1421,7 +1421,7 @@ platform: linux/arm64/v8 {{< include "compose/services-ports.md" >}} -> **Note** +> [!NOTE] > > Port mapping must not be used with `network_mode: host` otherwise a runtime error occurs. @@ -1461,7 +1461,7 @@ ports: - "6060:6060/udp" ``` -> **Note** +> [!NOTE] > > If Host IP mapping is not supported by a container engine, Compose rejects > the Compose file and ignores the specified host IP. @@ -1828,11 +1828,11 @@ The short syntax uses a single string with colon-separated values to specify a v - `z`: SELinux option indicating that the bind mount host content is shared among multiple containers. - `Z`: SELinux option indicating that the bind mount host content is private and unshared for other containers. -> **Note** +> [!NOTE] > > The SELinux re-labeling bind mount option is ignored on platforms without SELinux. -> **Note** +> [!NOTE] > Relative host paths are only supported by Compose that deploy to a > local container runtime. This is because the relative path is resolved from the Compose file’s parent > directory which is only applicable in the local case. When Compose deploys to a non-local @@ -1864,12 +1864,11 @@ expressed in the short form. - `mode`: The file mode for the tmpfs mount as Unix permission bits as an octal number. Introduced in Docker Compose version [2.14.0](../release-notes.md#2260). - `consistency`: The consistency requirements of the mount. Available values are platform specific. -> **Tip** +> [!TIP] > > Working with large repositories or monorepos, or with virtual file systems that are no longer scaling with your codebase? > Compose now takes advantage of [Synchronized file shares](../../desktop/synchronized-file-sharing.md) and automatically creates file shares for bind mounts. > Ensure you're signed in to Docker with a paid subscription and have enabled both **Access experimental features** and **Manage Synchronized file shares with Compose** in Docker Desktop's settings. -{ .tip } ### volumes_from diff --git a/content/compose/compose-file/07-volumes.md b/content/compose/compose-file/07-volumes.md index 2effe610a7..5ca67b381b 100644 --- a/content/compose/compose-file/07-volumes.md +++ b/content/compose/compose-file/07-volumes.md @@ -8,12 +8,11 @@ keywords: compose, compose specification, volumes, compose file reference To use a volume across multiple services, you must explicitly grant each service access by using the [volumes](05-services.md#volumes) attribute within the `services` top-level element. The `volumes` attribute has additional syntax that provides more granular control. -> **Tip** +> [!TIP] > > Working with large repositories or monorepos, or with virtual file systems that are no longer scaling with your codebase? > Compose now takes advantage of [Synchronized file shares](../../desktop/synchronized-file-sharing.md) and automatically creates file shares for bind mounts. > Ensure you're signed in to Docker with a paid subscription and have enabled both **Access experimental features** and **Manage Synchronized file shares with Compose** in Docker Desktop's settings. -{ .tip } ## Example diff --git a/content/compose/compose-file/09-secrets.md b/content/compose/compose-file/09-secrets.md index 15eb59141b..fdd4c4c132 100644 --- a/content/compose/compose-file/09-secrets.md +++ b/content/compose/compose-file/09-secrets.md @@ -38,4 +38,4 @@ secrets: ## Additional resources -For more information, see [How to use secrets in Compose](../use-secrets.md). \ No newline at end of file +For more information, see [How to use secrets in Compose](../use-secrets.md). diff --git a/content/compose/compose-file/10-fragments.md b/content/compose/compose-file/10-fragments.md index c19d8378d3..6218b8ce88 100644 --- a/content/compose/compose-file/10-fragments.md +++ b/content/compose/compose-file/10-fragments.md @@ -81,7 +81,7 @@ services: YET_ANOTHER: VARIABLE ``` -> **Note** +> [!NOTE] > > [YAML merge](https://yaml.org/type/merge.html) only applies to mappings, and can't be used with sequences. diff --git a/content/compose/compose-file/11-extension.md b/content/compose/compose-file/11-extension.md index 7c38954aac..39fae2d965 100644 --- a/content/compose/compose-file/11-extension.md +++ b/content/compose/compose-file/11-extension.md @@ -108,7 +108,7 @@ services: YET_ANOTHER: VARIABLE ``` -> **Note** +> [!NOTE] > > [YAML merge](https://yaml.org/type/merge.html) only applies to mappings, and can't be used with sequences. > diff --git a/content/compose/compose-file/15-profiles.md b/content/compose/compose-file/15-profiles.md index 8ea5225a71..2277def0f7 100644 --- a/content/compose/compose-file/15-profiles.md +++ b/content/compose/compose-file/15-profiles.md @@ -12,7 +12,7 @@ Services without a `profiles` attribute are always enabled. A service is ignored by Compose when none of the listed `profiles` match the active ones, unless the service is explicitly targeted by a command. In that case its profile is added to the set of active profiles. -> **Note** +> [!NOTE] > > All other top-level elements are not affected by `profiles` and are always active. diff --git a/content/compose/compose-file/_index.md b/content/compose/compose-file/_index.md index f793b83da5..0c021f9536 100644 --- a/content/compose/compose-file/_index.md +++ b/content/compose/compose-file/_index.md @@ -40,7 +40,6 @@ aliases: >**New to Docker Compose?** > > Find more information about the [key features and use cases of Docker Compose](../intro/features-uses.md) or [try the quickstart guide](../gettingstarted.md). -{ .tip } The Compose Specification is the latest and recommended version of the Compose file format. It helps you define a [Compose file](../compose-application-model.md) which is used to configure your Docker application’s services, networks, volumes, and more. diff --git a/content/compose/compose-file/deploy.md b/content/compose/compose-file/deploy.md index d4b592309b..c7fc6dccba 100644 --- a/content/compose/compose-file/deploy.md +++ b/content/compose/compose-file/deploy.md @@ -285,4 +285,4 @@ deploy: parallelism: 2 delay: 10s order: stop-first -``` \ No newline at end of file +``` diff --git a/content/compose/compose-file/develop.md b/content/compose/compose-file/develop.md index 519f0fca44..97653a3fbc 100644 --- a/content/compose/compose-file/develop.md +++ b/content/compose/compose-file/develop.md @@ -80,4 +80,4 @@ inside the path, which doesn't match any `ignore` rule, triggers the configured #### target `target` attribute only applies when `action` is configured for `sync`. Files within `path` with changes are synchronized -with container filesystem, so that the latter is always running with up-to-date content. \ No newline at end of file +with container filesystem, so that the latter is always running with up-to-date content. diff --git a/content/compose/compose-file/legacy-versions.md b/content/compose/compose-file/legacy-versions.md index 8ef07fbd08..46478ae68c 100644 --- a/content/compose/compose-file/legacy-versions.md +++ b/content/compose/compose-file/legacy-versions.md @@ -10,4 +10,4 @@ aliases: The legacy versions of the Compose file reference has moved to the [V1 branch of the Compose repository](https://github.com/docker/compose/tree/v1/docs). They are no longer being actively maintained. -The latest and recommended version of the Compose file format is defined by the [Compose Specification](_index.md). This format merges the 2.x and 3.x versions and is implemented by **Compose 1.27.0+**. For more information, see the[History and development of Docker Compose](../intro/history.md). \ No newline at end of file +The latest and recommended version of the Compose file format is defined by the [Compose Specification](_index.md). This format merges the 2.x and 3.x versions and is implemented by **Compose 1.27.0+**. For more information, see the[History and development of Docker Compose](../intro/history.md). diff --git a/content/compose/environment-variables/_index.md b/content/compose/environment-variables/_index.md index 5bb549bf9a..19ea021101 100644 --- a/content/compose/environment-variables/_index.md +++ b/content/compose/environment-variables/_index.md @@ -7,10 +7,9 @@ keywords: compose, orchestration, environment, env file By leveraging environment variables and interpolation in Docker Compose, you can create versatile and reusable configurations, making your Dockerized applications easier to manage and deploy across different environments. -> **Tip** +> [!TIP] > > Before using environment variables, read through all of the information first to get a full picture of environment variables in Docker Compose. -{ .tip } This section covers: diff --git a/content/compose/environment-variables/envvars.md b/content/compose/environment-variables/envvars.md index b2bc90a9a1..6b469e826f 100644 --- a/content/compose/environment-variables/envvars.md +++ b/content/compose/environment-variables/envvars.md @@ -163,7 +163,7 @@ When enabled, Compose displays a navigation menu where you can choose to open th * `false` or `0`, to disable. * Defaults to: `1` if you obtained Docker Compose through Docker Desktop, otherwise default is `0`. -> **Note** +> [!NOTE] > > Available in Docker Compose version 2.26.0 and later, and Docker Desktop version 4.29 and later @@ -176,7 +176,7 @@ This is an opt-out variable. When turned off it deactivates the experimental fea * `false` or `0`, to disable. * Defaults to: `1`. -> **Note** +> [!NOTE] > > Available in Docker Compose version 2.26.0 and later, and Docker Desktop version 4.29 and later diff --git a/content/compose/environment-variables/set-environment-variables.md b/content/compose/environment-variables/set-environment-variables.md index 7146ccb562..b95690e9ff 100644 --- a/content/compose/environment-variables/set-environment-variables.md +++ b/content/compose/environment-variables/set-environment-variables.md @@ -12,7 +12,6 @@ A container's environment is not set until there's an explicit entry in the serv >**Tip** > > Don't use environment variables to pass sensitive information, such as passwords, in to your containers. Use [secrets](../use-secrets.md) instead. -{ .tip } ## Use the `environment` attribute @@ -74,12 +73,11 @@ The [`env_file` attribute](../compose-file/05-services.md#env_file) also lets yo The paths to your `.env` file, specified in the `env_file` attribute, are relative to the location of your `compose.yml` file. -> **Important** +> [!IMPORTANT] > > Interpolation in `.env` files is a Docker Compose CLI feature. > > It is not supported when running `docker run --env-file ...`. -{ .important } ### Additional information diff --git a/content/compose/environment-variables/variable-interpolation.md b/content/compose/environment-variables/variable-interpolation.md index 519b1dfec3..f6a73065d9 100644 --- a/content/compose/environment-variables/variable-interpolation.md +++ b/content/compose/environment-variables/variable-interpolation.md @@ -105,21 +105,19 @@ services: ``` Docker Compose replaces `${DEBUG}` with the value from the `.env` file - > **Important** + > [!IMPORTANT] > > Be aware of [Environment variables precedence](envvars-precedence.md) when using variables in an `.env` file that as environment variables in your container's environment. - { .important } - You can place your `.env` file in a location other than the root of your project's directory, and then use the [`--env-file` option in the CLI](#substitute-with---env-file) so Compose can navigate to it. - Your `.env` file can be overridden by another `.env` if it is [substituted with `--env-file`](#substitute-with---env-file). -> **Important** +> [!IMPORTANT] > > Substitution from `.env` files is a Docker Compose CLI feature. > > It is not supported by Swarm when running `docker stack deploy`. -{ .important } #### `.env` file syntax @@ -244,7 +242,7 @@ When you run `docker compose up` with this configuration, Compose looks for the If an environment variable is not set, Compose substitutes with an empty string. In the previous example, if `POSTGRES_VERSION` is not set, the value for the image option is `postgres:`. -> **Note** +> [!NOTE] > > `postgres:` is not a valid image reference. Docker expects either a reference without a tag, like `postgres` which defaults to the latest image, or with a tag such as `postgres:15`. diff --git a/content/compose/file-watch.md b/content/compose/file-watch.md index 7384678f16..454dcfefbf 100644 --- a/content/compose/file-watch.md +++ b/content/compose/file-watch.md @@ -98,7 +98,6 @@ It will work well when you update a database configuration or your `nginx.conf` > Optimize your `Dockerfile` for speedy incremental rebuilds with [image layer caching](/build/cache) and [multi-stage builds](/build/building/multi-stage/). -{ .tip } ### `path` and `target` @@ -185,11 +184,10 @@ This setup demonstrates how to use the `sync+restart` action in Docker Compose t {{< include "compose/configure-watch.md" >}} -> **Tip** +> [!TIP] > > Watch can also be used with the dedicated `docker compose watch` command if you don't want to > get the application logs mixed with the (re)build logs and filesystem sync events. -{ .tip } > **Looking for a sample project to test things out?** > diff --git a/content/compose/gettingstarted.md b/content/compose/gettingstarted.md index 3d2b84f5fd..c69275ecde 100644 --- a/content/compose/gettingstarted.md +++ b/content/compose/gettingstarted.md @@ -63,7 +63,7 @@ Make sure you have: In this example, `redis` is the hostname of the redis container on the application's network and the default port, `6379` is used. - > **Note** + > [!NOTE] > > Note the way the `get_hit_count` function is written. This basic retry > loop attempts the request multiple times if the Redis service is @@ -112,10 +112,9 @@ Make sure you have: {{< /accordion >}} - > **Important** + > [!IMPORTANT] > >Check that the `Dockerfile` has no file extension like `.txt`. Some editors may append this file extension automatically which results in an error when you run the application. - { .important } For more information on how to write Dockerfiles, see the [Dockerfile reference](/reference/dockerfile/). @@ -242,7 +241,7 @@ Whenever a file is changed, Compose syncs the file to the corresponding location For more information on how Compose Watch works, see [Use Compose Watch](file-watch.md). Alternatively, see [Manage data in containers](/engine/storage/volumes.md) for other options. -> **Note** +> [!NOTE] > > For this example to work, the `--debug` option is added to the `Dockerfile`. The `--debug` option in Flask enables automatic code reload, making it possible to work on the backend API without the need to restart or rebuild the container. > After changing the `.py` file, subsequent API calls will use the new code, but the browser UI will not automatically refresh in this small example. Most frontend development servers include native live reload support that works with Compose. diff --git a/content/compose/gpu-support.md b/content/compose/gpu-support.md index 515d674eab..69ebd02fdb 100644 --- a/content/compose/gpu-support.md +++ b/content/compose/gpu-support.md @@ -22,12 +22,11 @@ This provides more granular control over a GPU reservation as custom values can - `options`. Key-value pairs representing driver specific options. -> **Important** +> [!IMPORTANT] > > You must set the `capabilities` field. Otherwise, it returns an error on service deployment. > > `count` and `device_ids` are mutually exclusive. You must only define one field at a time. -{ .important } For more information on these properties, see the [Compose Deploy Specification](compose-file/deploy.md#devices). diff --git a/content/compose/install/_index.md b/content/compose/install/_index.md index 43d224735c..1828363f50 100644 --- a/content/compose/install/_index.md +++ b/content/compose/install/_index.md @@ -34,16 +34,14 @@ If you already have Docker Engine and Docker CLI installed, you can install the - [Using Docker's repository](linux.md#install-using-the-repository) - [Downloading and installing manually](linux.md#install-the-plugin-manually) -> **Important** +> [!IMPORTANT] > >This is only available on Linux -{ .important } ### Scenario three: Install the Compose standalone You can [install the Compose standalone](standalone.md) on Linux or on Windows Server. -> **Warning** +> [!WARNING] > >This install scenario is not recommended and is only supported for backward compatibility purposes. -{ .warning } diff --git a/content/compose/install/linux.md b/content/compose/install/linux.md index 8a7d3c2408..62d27f0680 100644 --- a/content/compose/install/linux.md +++ b/content/compose/install/linux.md @@ -18,7 +18,7 @@ To install the Compose plugin on Linux, you can either: - [Set up Docker's repository on your Linux system](#install-using-the-repository). - [Install Compose manually](#install-the-plugin-manually). -> **Note** +> [!NOTE] > > These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin. For Compose standalone, see [Install Compose Standalone](standalone.md). @@ -83,7 +83,7 @@ To update the Compose plugin, run the following commands: ## Install the plugin manually -> **Note** +> [!NOTE] > > This option requires you to manage upgrades manually. We recommend setting up Docker's repository for easier maintenance. diff --git a/content/compose/install/standalone.md b/content/compose/install/standalone.md index fe59e04060..9ef55f8149 100644 --- a/content/compose/install/standalone.md +++ b/content/compose/install/standalone.md @@ -21,7 +21,7 @@ On this page you can find instructions on how to install Compose standalone on L 2. Apply executable permissions to the standalone binary in the target path for the installation. 3. Test and execute compose commands using `docker-compose`. - > **Tip** + > [!TIP] > > If the command `docker-compose` fails after installation, check your path. > You can also create a symbolic link to `/usr/bin` or any other directory in your path. @@ -29,7 +29,6 @@ On this page you can find instructions on how to install Compose standalone on L > ```console > $ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose > ``` - { .tip } ### On Windows Server @@ -50,7 +49,7 @@ on Microsoft Windows Server and want to install Docker Compose. Start-BitsTransfer -Source "https://github.com/docker/compose/releases/download/{{% param "compose_version" %}}/docker-compose-windows-x86_64.exe" -Destination $Env:ProgramFiles\Docker\docker-compose.exe ``` - > **Note** + > [!NOTE] > > On Windows Server 2019 you can add the Compose executable to `$Env:ProgramFiles\Docker`. Because this directory is registered in the system `PATH`, you can run the `docker-compose --version` diff --git a/content/compose/install/uninstall.md b/content/compose/install/uninstall.md index c629237248..e5a1d183a1 100644 --- a/content/compose/install/uninstall.md +++ b/content/compose/install/uninstall.md @@ -11,7 +11,7 @@ Uninstalling Docker Compose depends on the method you have used to install Docke If you want to uninstall Compose and you have installed Docker Desktop, see [Uninstall Docker Desktop](../../desktop/uninstall.md). -> **Note** +> [!NOTE] > > Unless you have other Docker instances installed on that specific environment, you would be removing Docker altogether by uninstalling the Desktop. @@ -51,7 +51,6 @@ Or, if you have installed Compose for all users, run: > If you get a **Permission denied** error using either of the above > methods, you do not have the permissions allowing you to remove > `docker-compose`. To force the removal, prepend `sudo` to either of the above instructions and run it again. -{ .tip } ### Inspect the location of the Compose CLI plugin @@ -60,4 +59,4 @@ To check where Compose is installed, use: ```console $ docker info --format '{{range .ClientInfo.Plugins}}{{if eq .Name "compose"}}{{.Path}}{{end}}{{end}}' -``` \ No newline at end of file +``` diff --git a/content/compose/migrate.md b/content/compose/migrate.md index 4162fcb6d9..7167fc8ed2 100644 --- a/content/compose/migrate.md +++ b/content/compose/migrate.md @@ -33,10 +33,9 @@ The Docker CLI platform provides a consistent and predictable set of options and This change lets you use all of the shared flags on the root `docker` command. For example, `docker --log-level=debug --tls compose up` enables debug logging from the Docker Engine as well as ensuring that TLS is used for the connection. -> **Tip** +> [!TIP] > > Update scripts to use Compose V2 by replacing the hyphen (`-`) with a space, using `docker compose` instead of `docker-compose`. -{ .tip } ### Service container names @@ -50,11 +49,10 @@ By using a hyphen instead, Compose V2 ensures service containers can be accessed For example, running the Compose command `-p myproject up --scale=1 svc` results in a container named `myproject_svc_1` with Compose V1 and a container named `myproject-svc-1` with Compose V2. -> **Tip** +> [!TIP] > >In Compose V2, the global `--compatibility` flag or `COMPOSE_COMPATIBILITY` environment variable preserves the Compose V1 behavior to use underscores (`_`) as the word separator. As this option must be specified for every Compose V2 command run, it's recommended that you only use this as a temporary measure while transitioning to Compose V2. -{ .tip } ### Command-line flags and subcommands @@ -87,14 +85,13 @@ Check if: - Any `.env` file values contain literal `$` signs in them. This is common with PHP projects. - Any variable values use advanced expansion syntax, for example `${VAR:?error}`. -> **Tip** +> [!TIP] > > Run `docker compose config` on the project to preview the configuration after Compose V2 has performed interpolation to verify that values appear as expected. > > Maintaining backwards compatibility with Compose V1 is typically achievable by ensuring that literal values (no interpolation) are single-quoted and values that should have interpolation applied are double-quoted. -{ .tip } ## What does this mean for my projects that use Compose V1? @@ -128,7 +125,6 @@ Yes. You can still download and install Compose V1 packages, but you won't get s >**Warning** > > The final Compose V1 release, version 1.29.2, was May 10, 2021. These packages haven't received any security updates since then. Use at your own risk. -{ .warning } ## Additional Resources diff --git a/content/compose/multiple-compose-files/extends.md b/content/compose/multiple-compose-files/extends.md index 291644b986..c7f67c26ab 100644 --- a/content/compose/multiple-compose-files/extends.md +++ b/content/compose/multiple-compose-files/extends.md @@ -17,7 +17,7 @@ service options in one place and refer to it from anywhere. You can refer to another Compose file and select a service you want to also use in your own application, with the ability to override some attributes for your own needs. -> **Important** +> [!IMPORTANT] > > When you use multiple Compose files, you must make sure all paths in the files are relative to the base Compose file (i.e. the Compose file in your main-project folder). This is required because extend files @@ -25,7 +25,6 @@ need not be valid Compose files. Extend files can contain small fragments of configuration. Tracking which fragment of a service is relative to which path is difficult and confusing, so to keep paths easier to understand, all paths must be defined relative to the base file. -{ .important } ## How it works diff --git a/content/compose/multiple-compose-files/include.md b/content/compose/multiple-compose-files/include.md index 5e9af00e43..d24f836a85 100644 --- a/content/compose/multiple-compose-files/include.md +++ b/content/compose/multiple-compose-files/include.md @@ -14,7 +14,7 @@ Each path listed in the `include` section loads as an individual Compose applica Once the included Compose application loads, all resources are copied into the current Compose application model. -> **Note** +> [!NOTE] > > `include` applies recursively so an included Compose file which declares its own `include` section, results in those other files being included as well. diff --git a/content/compose/multiple-compose-files/merge.md b/content/compose/multiple-compose-files/merge.md index b06eec1356..667f4eb0c4 100644 --- a/content/compose/multiple-compose-files/merge.md +++ b/content/compose/multiple-compose-files/merge.md @@ -66,7 +66,7 @@ webapp: - ANOTHER_VARIABLE=value ``` -> **Important** +> [!IMPORTANT] > > When you use multiple Compose files, you must make sure all paths in the files are relative to the base Compose file (the first Compose file specified @@ -75,7 +75,6 @@ Compose files. Override files can contain small fragments of configuration. Tracking which fragment of a service is relative to which path is difficult and confusing, so to keep paths easier to understand, all paths must be defined relative to the base file. -{ .important } ### Additional information diff --git a/content/compose/networking.md b/content/compose/networking.md index 84e0fb1c1c..4bb33c710f 100644 --- a/content/compose/networking.md +++ b/content/compose/networking.md @@ -11,7 +11,7 @@ By default Compose sets up a single container for a service joins the default network and is both reachable by other containers on that network, and discoverable by the service's name. -> **Note** +> [!NOTE] > > Your app's network is given a name based on the "project name", > which is based on the name of the directory it lives in. You can override the @@ -61,10 +61,9 @@ If you make a configuration change to a service and run `docker compose up` to u If any containers have connections open to the old container, they are closed. It is a container's responsibility to detect this condition, look up the name again and reconnect. -> **Tip** +> [!TIP] > > Reference containers by name, not IP, whenever possible. Otherwise you’ll need to constantly update the IP address you use. -{ .tip } ## Link containers diff --git a/content/compose/production.md b/content/compose/production.md index 448c6f3532..06c54678e7 100644 --- a/content/compose/production.md +++ b/content/compose/production.md @@ -61,4 +61,4 @@ You can use Compose to deploy an app to a remote Docker host by setting the appropriately. For more information, see [pre-defined environment variables](environment-variables/envvars.md). Once you've set up your environment variables, all the normal `docker compose` -commands work with no further configuration. \ No newline at end of file +commands work with no further configuration. diff --git a/content/compose/profiles.md b/content/compose/profiles.md index 735a701acd..4c7178c3a2 100644 --- a/content/compose/profiles.md +++ b/content/compose/profiles.md @@ -39,11 +39,10 @@ case running `docker compose up` would only start `backend` and `db`. Valid profiles names follow the regex format of `[a-zA-Z0-9][a-zA-Z0-9_.-]+`. -> **Tip** +> [!TIP] > > The core services of your application shouldn't be assigned `profiles` so > they are always enabled and automatically started. -{ .tip } ## Start specific profiles diff --git a/content/compose/project-name.md b/content/compose/project-name.md index 2f77ec8980..cd27bf472b 100644 --- a/content/compose/project-name.md +++ b/content/compose/project-name.md @@ -8,7 +8,7 @@ In Compose, the default project name is derived from the base name of the projec This page offers examples of scenarios where custom project names can be helpful, outlines the various methods to set a project name, and provides the order of precedence for each approach. -> **Note** +> [!NOTE] > > The default project directory is the base directory of the Compose file. A custom value can also be set > for it using the [`--project-directory` command line option](reference/_index.md). diff --git a/content/compose/release-notes.md b/content/compose/release-notes.md index 3a96544153..695d8c1162 100644 --- a/content/compose/release-notes.md +++ b/content/compose/release-notes.md @@ -372,7 +372,7 @@ This release fixes a build issue with Docker Desktop for Windows introduced in C {{< release-date date="2023-09-21" >}} -> **Note** +> [!NOTE] > > The `watch` command is now generally available (GA). You can directly use it from the root command `docker compose watch`. > For more information, see [File watch](./file-watch.md). @@ -398,7 +398,7 @@ This release fixes a build issue with Docker Desktop for Windows introduced in C {{< release-date date="2023-08-30" >}} -> **Note** +> [!NOTE] > > The format of `docker compose ps` and `docker compose ps --format=json` changed to better align with `docker ps` output. See [compose#10918](https://github.com/docker/compose/pull/10918). @@ -864,7 +864,7 @@ For the full change log or additional information, check the [Compose repository {{< release-date date="2022-09-27" >}} -> **Note** +> [!NOTE] > > - Updates on environment file syntax & interpolation: see [compose#9879](https://github.com/docker/compose/issues/9879) > - Setting `DOCKER_HOST` via `.env` files is not supported in Compose v2 @@ -1002,13 +1002,12 @@ For the full change log, check the [Compose repository 2.10.0 release page](http {{< release-date date="2022-08-7" >}} -> **Important** +> [!IMPORTANT] > > Compose v2.9.0 contains changes to the environment variable's precedence that have since been reverted. We recommend using v2.10+ to avoid compatibility issues. > -{ .important } -> **Note** +> [!NOTE] > > This release reverts the breaking changes introduced in [Compose v2.8.0](#280) by [`compose-go v1.3.0`](https://github.com/compose-spec/compose-go/releases/tag/v1.3.0). @@ -1028,14 +1027,13 @@ For the full change log or additional information, check the [Compose repository {{< release-date date="2022-07-29" >}} -> **Important** +> [!IMPORTANT] > >This release introduced a breaking change via `compose-go v1.3.0` and this [PR](https://github.com/compose-spec/compose-go/pull/294). In this release, Docker Compose recreates new resources (networks, volumes, secrets, configs, etc.) with new names, using a `-` (dash) instead an `_` (underscore) and tries to connect to or use these newly created resources instead of your existing ones! > > Please use Compose the v2.9.0 release instead. > -{ .important } ### New @@ -1838,7 +1836,7 @@ This release contains minor improvements and bug fixes. - Reverted a 1.23.0 change that appended random strings to container names created by `docker-compose up`, causing addressability issues. - > **Note**: Containers created by `docker-compose run` will continue to use + > [!NOTE]: Containers created by `docker-compose run` will continue to use randomly generated names to avoid collisions during parallel runs. - Fixed an issue where some `dockerfile` paths would fail unexpectedly when diff --git a/content/compose/use-secrets.md b/content/compose/use-secrets.md index 082f4a66db..a6d95bbc85 100644 --- a/content/compose/use-secrets.md +++ b/content/compose/use-secrets.md @@ -80,7 +80,7 @@ In the advanced example above: - The top-level `secrets` section defines the variables `db_password` and `db_root_password` and provides the `file` that populates their values. - The deployment of each container means Docker creates a temporary filesystem mount under `/run/secrets/` with their specific values. -> **Note** +> [!NOTE] > > The `_FILE` environment variables demonstrated here are a convention used by some images, including Docker Official Images like [mysql](https://hub.docker.com/_/mysql) and [postgres](https://hub.docker.com/_/postgres). diff --git a/content/contribute/checklist.md b/content/contribute/checklist.md index 628c3d9e89..2bf8d0550d 100644 --- a/content/contribute/checklist.md +++ b/content/contribute/checklist.md @@ -51,4 +51,4 @@ For information on how to add redirects, see [Source file conventions](file-conv ##### Completed a final spelling, punctuation, and grammar check -For more in-depth information on our Style Guide, explore the [grammar](style/grammar.md) or [formatting](style/formatting.md) guides. \ No newline at end of file +For more in-depth information on our Style Guide, explore the [grammar](style/grammar.md) or [formatting](style/formatting.md) guides. diff --git a/content/contribute/components/buttons.md b/content/contribute/components/buttons.md index 8f1298527c..7e7aed3fdb 100644 --- a/content/contribute/components/buttons.md +++ b/content/contribute/components/buttons.md @@ -12,4 +12,4 @@ toc_max: 3 ```go {{}} -``` \ No newline at end of file +``` diff --git a/content/contribute/components/call-outs.md b/content/contribute/components/call-outs.md index c0f991606f..48f272d10a 100644 --- a/content/contribute/components/call-outs.md +++ b/content/contribute/components/call-outs.md @@ -8,9 +8,6 @@ We support these broad categories of callouts: - Version callouts - Notes (no HTML attribute required) -- Tips, which use the `{ .tip }` class -- Important, which use the `{ .important }` class -- Warning, which use the `{ .warning }` class - Experimental, which use the `{ .experimental }` class - Restricted, which use the `{ .restricted }` class @@ -18,7 +15,7 @@ We support these broad categories of callouts: {{< introduced buildx 0.10.4 >}} -> **Note** +> [!NOTE] > > Note the way the `get_hit_count` function is written. This basic retry > loop lets us attempt our request multiple times if the redis service is @@ -28,20 +25,18 @@ We support these broad categories of callouts: > cluster, this also helps handling momentary connection drops between > nodes. -> **Tip** +> [!TIP] > > For a smaller base image, use `alpine`. -{ .tip } -> **Important** +> [!IMPORTANT] > > Treat access tokens like your password and keep them secret. Store your > tokens securely (for example, in a credential manager). -{ .important } -> **Warning** +> [!WARNING] > > Removing Volumes > @@ -50,7 +45,6 @@ We support these broad categories of callouts: > the `--volumes` flag. > > The Docker Dashboard does not remove volumes when you delete the app stack. -{ .warning } For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them. @@ -72,7 +66,7 @@ For both of the following callouts, consult [the Docker release lifecycle](/rele ``` ```html -> **Note** +> [!NOTE] > > Note the way the `get_hit_count` function is written. This basic retry > loop lets us attempt our request multiple times if the redis service is @@ -82,18 +76,16 @@ For both of the following callouts, consult [the Docker release lifecycle](/rele > cluster, this also helps handling momentary connection drops between > nodes. -> **Tip** +> [!TIP] > > For a smaller base image, use `alpine`. -{ .tip } -> **Important** +> [!IMPORTANT] > > Treat access tokens like your password and keep them secret. Store your > tokens securely (for example, in a credential manager). -{ .important } -> **Warning** +> [!WARNING] > > Removing Volumes > @@ -102,7 +94,6 @@ For both of the following callouts, consult [the Docker release lifecycle](/rele > the `--volumes` flag. > > The Docker Dashboard does _not_ remove volumes when you delete the app stack. -{ .warning } > **Beta feature** > diff --git a/content/contribute/components/cards.md b/content/contribute/components/cards.md index 23f4e693ed..0dc0f009cf 100644 --- a/content/contribute/components/cards.md +++ b/content/contribute/components/cards.md @@ -36,7 +36,7 @@ The parameters for this shortcode are: | link | (Optional) The link target of the card, when clicked | | description | A description text, in Markdown | -> **Note** +> [!NOTE] > > There's a known limitation with the Markdown description of cards, > in that they can't contain relative links, pointing to other .md documents. @@ -94,4 +94,4 @@ grid: description: Clang bang icon: "build" link: "/build/" -``` \ No newline at end of file +``` diff --git a/content/contribute/components/links.md b/content/contribute/components/links.md index d76e7266e9..97f47fbd4f 100644 --- a/content/contribute/components/links.md +++ b/content/contribute/components/links.md @@ -24,4 +24,4 @@ about them in advance. ```md [External links](https://docker.com) [Internal links](links.md) -``` \ No newline at end of file +``` diff --git a/content/contribute/components/lists.md b/content/contribute/components/lists.md index 472c84e987..551b47af88 100644 --- a/content/contribute/components/lists.md +++ b/content/contribute/components/lists.md @@ -17,7 +17,7 @@ Use dashes (`-`) or asterisks (`*`) for bullet points. 2. Numbered list item 2. Let's put a note in it. - > **Note**: We did it! + > [!NOTE]: We did it! 3. Numbered list item 3 with a code block in it. You need the blank line before the code block happens. @@ -53,7 +53,7 @@ Use dashes (`-`) or asterisks (`*`) for bullet points. 2. Numbered list item 2. Let's put a note in it. - > **Note**: We did it! + > [!NOTE]: We did it! 3. Numbered list item 3 with a code block in it. You need the blank line before the code block happens. diff --git a/content/contribute/components/tables.md b/content/contribute/components/tables.md index d18fadb328..1631bafb2b 100644 --- a/content/contribute/components/tables.md +++ b/content/contribute/components/tables.md @@ -51,4 +51,4 @@ character is optional (unless the last cell is supposed to be empty). | Debian | ✅ | | Fedora | | | Arch (btw) | ✅ | -``` \ No newline at end of file +``` diff --git a/content/contribute/style/terminology.md b/content/contribute/style/terminology.md index 711b2e90c5..6af94fd572 100644 --- a/content/contribute/style/terminology.md +++ b/content/contribute/style/terminology.md @@ -60,4 +60,4 @@ Online storage for Docker images. #### Repository -Lets users share container images with their team, customers, or Docker community. \ No newline at end of file +Lets users share container images with their team, customers, or Docker community. diff --git a/content/contribute/style/voice-tone.md b/content/contribute/style/voice-tone.md index a9c708860e..850e60d9a0 100644 --- a/content/contribute/style/voice-tone.md +++ b/content/contribute/style/voice-tone.md @@ -46,4 +46,4 @@ For example, **instead of**: **Use**: -“*Features such as Single Sign-on (SSO), Image Access Management, Registry Access Management are available in Docker Business subscription*.” \ No newline at end of file +“*Features such as Single Sign-on (SSO), Image Access Management, Registry Access Management are available in Docker Business subscription*.” diff --git a/content/desktop/allow-list.md b/content/desktop/allow-list.md index 487f252d19..f9692300ef 100644 --- a/content/desktop/allow-list.md +++ b/content/desktop/allow-list.md @@ -24,4 +24,4 @@ This page contains the domain URLs that you need to add to a firewall allowlist |https://registry-1.docker.io| Docker Pull/Push | |https://production.cloudflare.docker.com| Docker Pull/Push | |https://docker-pinata-support.s3.amazonaws.com| Troubleshooting | -|https://api.dso.docker.com| Docker Scout service | \ No newline at end of file +|https://api.dso.docker.com| Docker Scout service | diff --git a/content/desktop/backup-and-restore.md b/content/desktop/backup-and-restore.md index f0ccc5be05..a8a4f5e3b2 100644 --- a/content/desktop/backup-and-restore.md +++ b/content/desktop/backup-and-restore.md @@ -10,7 +10,6 @@ computer, for example. > Should I back up my containers? > > If you use volumes or bind-mounts to store your container data, backing up your containers may not be needed, but make sure to remember the options that were used when creating the container or use a [Docker Compose file](../compose/compose-file/index.md) if you want to re-create your containers with the same configuration after re-installation. -{ .tip } ## Save your data diff --git a/content/desktop/containerd.md b/content/desktop/containerd.md index 454467b806..c6f8854784 100644 --- a/content/desktop/containerd.md +++ b/content/desktop/containerd.md @@ -8,7 +8,7 @@ toc_max: 3 This page provides information about the ongoing integration of `containerd` for image and file system management in the Docker Engine. -> **Note** +> [!NOTE] > > After switching to the containerd image store, > images and containers in the classic image store won't be visible. diff --git a/content/desktop/dev-environments/create-dev-env.md b/content/desktop/dev-environments/create-dev-env.md index c976232012..1cfccc2d7f 100644 --- a/content/desktop/dev-environments/create-dev-env.md +++ b/content/desktop/dev-environments/create-dev-env.md @@ -19,7 +19,6 @@ This does not conflict with any of the local files or local tooling set up on yo >Tip > >Install the [Dev Environments browser extension](https://github.com/docker/dev-envs-extension) for [Chrome](https://chrome.google.com/webstore/detail/docker-dev-environments/gnagpachnalcofcblcgdbofnfakdbeka) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/docker-dev-environments/), to launch a dev environment faster. -{ .tip } ## Prerequisites @@ -33,14 +32,13 @@ To get started with Dev Environments, you must also install the following tools ## Launch a dev environment from a Git repository -> **Note** +> [!NOTE] > > When cloning a Git repository using SSH, ensure you've added your SSH key to the ssh-agent. To do this, open a terminal and run `ssh-add `. -> **Important** +> [!IMPORTANT] > > If you have enabled the WSL 2 integration in Docker Desktop for Windows, make sure you have an SSH agent running in your WSL 2 distribution. -{ .important } {{< accordion title="How to start an SSH agent in WSL 2" >}} @@ -121,7 +119,7 @@ To launch the application, run the command `make run` in your terminal. This ope A directory from your computer is bind mounted to the container, so any changes you make locally is reflected in the dev environment. You can use an editor or IDE of your choice. -> **Note** +> [!NOTE] > > When using a local folder for a dev environment, file changes are synchronized between your environment container and your local files. This can affect the performance inside the container, depending on the number of files in your local folder and the operations performed in the container. diff --git a/content/desktop/dev-environments/set-up.md b/content/desktop/dev-environments/set-up.md index b6b231696a..1f56071177 100644 --- a/content/desktop/dev-environments/set-up.md +++ b/content/desktop/dev-environments/set-up.md @@ -86,4 +86,4 @@ In the example, the Docker Compose files are the same. However, they could be di ## What's next? -Learn how to [distribute your dev environment](share.md) \ No newline at end of file +Learn how to [distribute your dev environment](share.md) diff --git a/content/desktop/dev-environments/share.md b/content/desktop/dev-environments/share.md index d986e37cbe..54676995b6 100644 --- a/content/desktop/dev-environments/share.md +++ b/content/desktop/dev-environments/share.md @@ -24,4 +24,4 @@ The following example opens a [Compose sample](https://github.com/docker/awesome ### Open a dev environment that has been distributed to you -To open a dev environment that has been shared with you, select the **Create** button in the top right-hand corner, select source **Existing Git repo**, and then paste the URL. \ No newline at end of file +To open a dev environment that has been shared with you, select the **Create** button in the top right-hand corner, select source **Existing Git repo**, and then paste the URL. diff --git a/content/desktop/enterprise/_index.md b/content/desktop/enterprise/_index.md index 64ab7800f3..410d4e75f5 100644 --- a/content/desktop/enterprise/_index.md +++ b/content/desktop/enterprise/_index.md @@ -20,4 +20,4 @@ Docker Desktop Enterprise (DDE) has been deprecated and is no longer in active d If you are an existing DDE customer, use our [Support form](https://hub.docker.com/support/desktop/) to request a transition to one of our new [subscription plans](https://www.docker.com/pricing). -If you are looking to deploy Docker Desktop at scale, contact us on [pricingquestions@docker.com](mailto:pricingquestions@docker.com). \ No newline at end of file +If you are looking to deploy Docker Desktop at scale, contact us on [pricingquestions@docker.com](mailto:pricingquestions@docker.com). diff --git a/content/desktop/faqs/macfaqs.md b/content/desktop/faqs/macfaqs.md index aa451e8f0a..8b13a98a17 100644 --- a/content/desktop/faqs/macfaqs.md +++ b/content/desktop/faqs/macfaqs.md @@ -68,7 +68,6 @@ To move the disk image file to a different location: >**Important** > > Do not move the file directly in Finder as this can cause Docker Desktop to lose track of the file. -{ .important } ##### How do I delete unnecessary containers and images? @@ -163,7 +162,7 @@ $ security add-trusted-cert -d -r trustRoot -k ~/Library/Keychains/login.keychai See also, [Directory structures for certificates](#directory-structures-for-certificates). -> **Note** +> [!NOTE] > > You need to restart Docker Desktop after making any changes to the keychain or > to the `~/.docker/certs.d` directory in order for the changes to take effect. @@ -182,7 +181,7 @@ When the Docker Desktop application starts, it copies the `~/.docker/certs.d` folder on your Mac to the `/etc/docker/certs.d` directory on Moby (the Docker Desktop `xhyve` virtual machine). -> **Note** +> [!NOTE] > > * You need to restart Docker Desktop after making any changes to the keychain > or to the `~/.docker/certs.d` directory in order for the changes to take diff --git a/content/desktop/get-started.md b/content/desktop/get-started.md index a5e7ea7ea5..21d44f2b30 100644 --- a/content/desktop/get-started.md +++ b/content/desktop/get-started.md @@ -31,7 +31,7 @@ Docker recommends that you authenticate using the **Sign in** option in the top- In large enterprises where admin access is restricted, administrators can [enforce sign-in](../security/for-admins/enforce-sign-in/_index.md). -> **Tip** +> [!TIP] > > Explore [Docker's core subscriptions](https://www.docker.com/pricing/) to see what else Docker can offer you. @@ -43,7 +43,7 @@ In large enterprises where admin access is restricted, administrators can [enfor - Improve your organization’s security posture for containerized development by taking advantage of [Hardened Desktop](/security/for-admins/hardened-desktop/index.md). -> **Note** +> [!NOTE] > > Docker Desktop automatically signs you out after 90 days, or after 30 days of inactivity. diff --git a/content/desktop/gpu.md b/content/desktop/gpu.md index df78545a4a..0e3b2e5ce1 100644 --- a/content/desktop/gpu.md +++ b/content/desktop/gpu.md @@ -5,7 +5,7 @@ keywords: gpu, gpu support, nvidia, wsl2, docker desktop, windows toc_max: 3 --- -> **Note** +> [!NOTE] > > Currently GPU support in Docker Desktop is only available on Windows with the WSL2 backend. diff --git a/content/desktop/install/debian.md b/content/desktop/install/debian.md index 7e733ee599..62a00ae7f9 100644 --- a/content/desktop/install/debian.md +++ b/content/desktop/install/debian.md @@ -47,7 +47,7 @@ Recommended approach to install Docker Desktop on Debian: ``` Don't forget to substitute `` with the architecture you want. - > **Note** + > [!NOTE] > > At the end of the installation process, `apt` displays an error due to installing a downloaded package. You > can ignore this error message. diff --git a/content/desktop/install/linux-install.md b/content/desktop/install/linux-install.md index f513d32d2d..f1b93e3b24 100644 --- a/content/desktop/install/linux-install.md +++ b/content/desktop/install/linux-install.md @@ -19,7 +19,7 @@ aliases: This page contains information about general system requirements, supported platforms, and instructions on how to install Docker Desktop for Linux. -> **Important** +> [!IMPORTANT] > >Docker Desktop on Linux runs a Virtual Machine (VM) which creates and uses a custom docker context, `desktop-linux`, on startup. > @@ -27,10 +27,9 @@ This page contains information about general system requirements, supported plat > > {{< accordion title=" What is the difference between Docker Desktop for Linux and Docker Engine?" >}} -> **Important** +> [!IMPORTANT] > -> For commercial use of Docker Engine obtained via Docker Desktop within larger enterprises (exceeding 250 employees OR with annual revenue surpassing $10 million USD), a [paid subscription](https://www.docker.com/pricing/) is required. -{ .important } +> For commercial use of Docker Engine obtained via Docker Desktop within larger enterprises (exceeding 250 employees OR with annual revenue surpassing $10 million USD), a [paid subscription](https://www.docker.com/pricing/) is required. Docker Desktop for Linux provides a user-friendly graphical interface that simplifies the management of containers and services. It includes Docker Engine as this is the core technology that powers Docker containers. Docker Desktop for Linux also comes with additional features like Docker Scout and Docker Extensions. @@ -110,7 +109,6 @@ Current context is now "desktop-linux" ``` Refer to the [Docker Context documentation](/engine/manage-resources/contexts.md) for more details. {{< /accordion >}} -{ .important } ## Supported platforms @@ -148,7 +146,7 @@ To install Docker Desktop successfully, your Linux host must meet the following Docker Desktop for Linux runs a Virtual Machine (VM). For more information on why, see [Why Docker Desktop for Linux runs a VM](../faqs/linuxfaqs.md#why-does-docker-desktop-for-linux-run-a-vm). -> **Note** +> [!NOTE] > > Docker does not provide support for running Docker Desktop for Linux in nested virtualization scenarios. We recommend that you run Docker Desktop for Linux natively on supported distributions. diff --git a/content/desktop/install/mac-install.md b/content/desktop/install/mac-install.md index e28d3abe93..b4d4796c95 100644 --- a/content/desktop/install/mac-install.md +++ b/content/desktop/install/mac-install.md @@ -35,10 +35,9 @@ This page contains download URLs, information about system requirements, and ins - A supported version of macOS. - > **Important** + > [!IMPORTANT] > > Docker supports Docker Desktop on the most recent versions of macOS. That is, the current release of macOS and the previous two releases. As new major versions of macOS are made generally available, Docker stops supporting the oldest version and supports the newest version of macOS (in addition to the previous two releases). - { .important } - At least 4 GB of RAM. @@ -47,10 +46,9 @@ This page contains download URLs, information about system requirements, and ins - A supported version of macOS. - > **Important** + > [!IMPORTANT] > > Docker supports Docker Desktop on the most recent versions of macOS. That is, the current release of macOS and the previous two releases. As new major versions of macOS are made generally available, Docker stops supporting the oldest version and supports the newest version of macOS (in addition to the previous two releases). - { .important } - At least 4 GB of RAM. - For the best experience, it's recommended that you install Rosetta 2. There is no longer a hard requirement to install Rosetta 2, however there are a few optional command line tools that still require Rosetta 2 when using Darwin/AMD64. See [Known issues](../troubleshoot/known-issues.md). To install Rosetta 2 manually from the command line, run the following command: @@ -115,7 +113,7 @@ The `install` command accepts the following flags: - `--override-proxy-https=`: Sets the URL of the HTTP proxy that must be used for outgoing HTTPS requests, requires `--proxy-http-mode` to be `manual` - `--override-proxy-exclude=`: Bypasses proxy settings for the hosts and domains. It's a comma-separated list. -> **Tip** +> [!TIP] > > As an IT administrator, you can use endpoint management (MDM) software to identify the number of Docker Desktop instances and their versions within your environment. This can provide accurate license reporting, help ensure your machines use the latest version of Docker Desktop, and enable you to [enforce sign-in](../../security/for-admins/enforce-sign-in/_index.md). > - [Intune](https://learn.microsoft.com/en-us/mem/intune/apps/app-discovered-apps) @@ -123,7 +121,6 @@ The `install` command accepts the following flags: > - [Kandji](https://support.kandji.io/support/solutions/articles/72000559793-view-a-device-application-list) > - [Kolide](https://www.kolide.com/features/device-inventory/properties/mac-apps) > - [Workspace One](https://blogs.vmware.com/euc/2022/11/how-to-use-workspace-one-intelligence-to-manage-app-licenses-and-reduce-costs.html) -{ .tip } ## Where to go next diff --git a/content/desktop/install/msi/_index.md b/content/desktop/install/msi/_index.md index 731bbb46cb..bbcf289bdf 100644 --- a/content/desktop/install/msi/_index.md +++ b/content/desktop/install/msi/_index.md @@ -20,4 +20,4 @@ Whether you're looking to implement scripted installations or integrate Docker D - [Use the Microsoft installer and read the configuration options](install-and-configure.md) - [Read the FAQs](faq.md) -- [Install with Intune](use-intune.md) \ No newline at end of file +- [Install with Intune](use-intune.md) diff --git a/content/desktop/install/msi/install-and-configure.md b/content/desktop/install/msi/install-and-configure.md index f396906593..d7d268e9bd 100644 --- a/content/desktop/install/msi/install-and-configure.md +++ b/content/desktop/install/msi/install-and-configure.md @@ -36,7 +36,7 @@ If your administrator account is different to your user account, you must add th 3. Right-click to add the user to the group. 4. Sign out and sign back in for the changes to take effect. -> **Note** +> [!NOTE] > > When installing Docker Desktop with the MSI, in-app updates are automatically disabled. This feature ensures your organization maintains the required Docker Desktop version. For Docker Desktop installed with the .exe installer, in-app updates remain supported. > @@ -64,10 +64,9 @@ Non-interactive installations are silent and any additional configuration must b ### Common installation commands -> **Important** +> [!IMPORTANT] > > Admin rights are required to run any of the following commands. -{ .important } #### Installing interactively with verbose logging @@ -111,7 +110,7 @@ For example: msiexec /i "DockerDesktop.msi" /L*V ".\msi.log" /passive /norestart ``` -> **Tip** +> [!TIP] > > Some useful tips to remember when creating a value that expects a JSON string as it’s value: > @@ -119,7 +118,6 @@ msiexec /i "DockerDesktop.msi" /L*V ".\msi.log" /passive /norestart > - The string should be wrapped in double quotes > - The string shouldn't contain any whitespace > - Property names are expected to be in double quotes -{ .tip } ### Common uninstall commands @@ -138,7 +136,7 @@ IdentifyingNumber Name ----------------- ---- {10FC87E2-9145-4D7D-B493-2E99E8D8E103} Docker Desktop ``` -> **Note** +> [!NOTE] > > This command can take some time to return, depending on the number of installed applications. @@ -174,10 +172,9 @@ msiexec /x "DockerDesktop.msi" /quiet ### Configuration options -> **Important** +> [!IMPORTANT] > > In addition to the following custom properties, the Docker Desktop MSI installer also supports the standard [Windows Installer command line options](https://learn.microsoft.com/en-us/windows/win32/msi/standard-installer-command-line-options). -{ .important } | Property | Description | Default | | :--- | :--- | :--- | diff --git a/content/desktop/install/msi/use-intune.md b/content/desktop/install/msi/use-intune.md index b75f8842f3..1e9fdda03b 100644 --- a/content/desktop/install/msi/use-intune.md +++ b/content/desktop/install/msi/use-intune.md @@ -13,17 +13,16 @@ Learn how to deploy Docker Desktop using Intune, Microsoft's cloud-based device 5. Complete any relevant details such as the description, publisher, or app version and then select **Next**. 6. Optional: On the **Program** tab, you can update the **Install command** field to suit your needs. The field is pre-populated with `msiexec /i "DockerDesktop.msi" /qn`. See the [Common installation scenarios](install-and-configure.md) for examples on the changes you can make. - > **Tip** + > [!TIP] > > It's recommended you configure the Intune deployment to schedule a reboot of the machine on successful installs. > > This is because the Docker Desktop installer installs Windows features depending on your engine selection and also updates the membership of the `docker-users` local group. > > You may also want to set Intune to determine behaviour based on return codes and watch for a return code of `3010`. - { .tip } 7. Complete the rest of the tabs and then review and create the app. ## Additional resources -- [Explore the FAQs](faq.md). \ No newline at end of file +- [Explore the FAQs](faq.md). diff --git a/content/desktop/install/rhel.md b/content/desktop/install/rhel.md index b3db18c8e6..ba6d4742e9 100644 --- a/content/desktop/install/rhel.md +++ b/content/desktop/install/rhel.md @@ -122,7 +122,6 @@ The post-install script: > ```console > $ docker run --rm -it -v "/etc/pki/entitlement:/etc/pki/entitlement" -v "/etc/rhsm:/etc/rhsm-host" -v "/etc/yum.repos.d/redhat.repo:/etc/yum.repos.d/redhat.repo" registry.access.redhat.com/ubi9 > ``` -{ .tip } ## Upgrade Docker Desktop diff --git a/content/desktop/install/ubuntu.md b/content/desktop/install/ubuntu.md index d5ab2e809e..bc1cb07177 100644 --- a/content/desktop/install/ubuntu.md +++ b/content/desktop/install/ubuntu.md @@ -25,7 +25,7 @@ To install Docker Desktop successfully, you must: - Meet the [general system requirements](linux-install.md#general-system-requirements). - Have a 64-bit version of either the LTS version Ubuntu Jammy Jellyfish 22.04, or the current non-LTS version. Docker Desktop is supported on `x86_64` (or `amd64`) architecture. - > **Note** + > [!NOTE] > > The latest Ubuntu 24.04 LTS is not yet supported. Docker Desktop will fail to start. Due to a change in how the latest Ubuntu release restricts the unprivileged namespaces, `sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0` needs to be run at least once. Refer to the [Ubuntu Blog](https://ubuntu.com/blog/ubuntu-23-10-restricted-unprivileged-user-namespaces) for more details. @@ -52,7 +52,7 @@ Recommended approach to install Docker Desktop on Ubuntu: Don't forget to substitute `` with the architecture you want. - > **Note** + > [!NOTE] > > At the end of the installation process, `apt` displays an error due to installing a downloaded package. You > can ignore this error message. diff --git a/content/desktop/install/windows-install.md b/content/desktop/install/windows-install.md index bedfaa2f01..7295a7327a 100644 --- a/content/desktop/install/windows-install.md +++ b/content/desktop/install/windows-install.md @@ -34,10 +34,11 @@ _For checksums, see [Release notes](../release-notes.md)_ ## System requirements +> [!TIP] +> > **Should I use Hyper-V or WSL?** > > Docker Desktop's functionality remains consistent on both WSL and Hyper-V, without a preference for either architecture. Hyper-V and WSL have their own advantages and disadvantages, depending on your specific set up and your planned use case. -{ .tip } {{< tabs >}} {{< tab name="WSL 2 backend, x86_64" >}} @@ -58,15 +59,14 @@ _For checksums, see [Release notes](../release-notes.md)_ For more information on setting up WSL 2 with Docker Desktop, see [WSL](../wsl/_index.md). -> **Note** +> [!NOTE] > > Docker only supports Docker Desktop on Windows for those versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). Docker Desktop is not supported on server versions of Windows, such as Windows Server 2019 or Windows Server 2022. For more information on how to run containers on Windows Server, see [Microsoft's official documentation](https://learn.microsoft.com/virtualization/windowscontainers/quick-start/set-up-environment). -> **Important** +> [!IMPORTANT] > > To run Windows containers, you need Windows 10 or Windows 11 Professional or Enterprise edition. > Windows Home or Education editions only allow you to run Linux containers. -{ .important } {{< /tab >}} {{< tab name="Hyper-V backend, x86_64" >}} @@ -85,15 +85,14 @@ For more information on setting up WSL 2 with Docker Desktop, see [WSL](../wsl/_ BIOS settings. For more information, see [Virtualization](../troubleshoot/topics.md#virtualization). -> **Note** +> [!NOTE] > > Docker only supports Docker Desktop on Windows for those versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). Docker Desktop is not supported on server versions of Windows, such as Windows Server 2019 or Windows Server 2022. For more information on how to run containers on Windows Server, see [Microsoft's official documentation](https://learn.microsoft.com/virtualization/windowscontainers/quick-start/set-up-environment). -> **Important** +> [!IMPORTANT] > > To run Windows containers, you need Windows 10 or Windows 11 Professional or Enterprise edition. -> Windows Home or Education editions only let you run Linux containers. -{ .important } +> Windows Home or Education editions only allow you to run Linux containers. {{< /tab >}} {{< tab name="WSL 2 backend, Arm (Beta)" >}} @@ -112,12 +111,11 @@ For more information on setting up WSL 2 with Docker Desktop, see [WSL](../wsl/_ - Enable hardware virtualization in BIOS. For more information, see [Virtualization](../troubleshoot/topics.md#virtualization). -> **Important** +> [!IMPORTANT] > > The following features are not supported: > - Hyper-V backend > - Windows containers -{ .important } {{< /tab >}} {{< /tabs >}} @@ -152,7 +150,7 @@ For more information on Windows containers, refer to the following documentation - To understand how to connect to Windows containers from the local host, see [I want to connect to a container from Windows](../networking.md#i-want-to-connect-to-a-container-from-the-host) -> **Note** +> [!NOTE] > > When you switch to Windows containers, **Settings** only shows those tabs that are active and apply to your Windows containers. @@ -235,7 +233,7 @@ The `install` command accepts the following flags: - `--wsl-default-data-root=`: Specifies the default location for the WSL distribution disk. - `--always-run-service`: After installation completes, starts `com.docker.service` and sets the service startup type to Automatic. This circumvents the need for administrator privileges, which are otherwise necessary to start `com.docker.service`. `com.docker.service` is required by Windows containers and Hyper-V backend. -> **Note** +> [!NOTE] > > If you're using PowerShell, you need to use the `ArgumentList` parameter before any flags. > For example: @@ -265,7 +263,7 @@ Docker Desktop does not start automatically after installation. To start Docker For more information, see [Docker Desktop Subscription Service Agreement](https://www.docker.com/legal/docker-subscription-service-agreement/). It is recommended that you read the [FAQs](https://www.docker.com/pricing/faq). -> **Tip** +> [!TIP] > > As an IT administrator, you can use endpoint management (MDM) software to identify the number of Docker Desktop instances and their versions within your environment. This can provide accurate license reporting, help ensure your machines use the latest version of Docker Desktop, and enable you to [enforce sign-in](../../security/for-admins/enforce-sign-in/_index.md). > - [Intune](https://learn.microsoft.com/en-us/mem/intune/apps/app-discovered-apps) @@ -273,7 +271,6 @@ Docker Desktop does not start automatically after installation. To start Docker > - [Kandji](https://support.kandji.io/support/solutions/articles/72000559793-view-a-device-application-list) > - [Kolide](https://www.kolide.com/features/device-inventory/properties/mac-apps) > - [Workspace One](https://blogs.vmware.com/euc/2022/11/how-to-use-workspace-one-intelligence-to-manage-app-licenses-and-reduce-costs.html) -{ .tip } ## Where to go next diff --git a/content/desktop/kubernetes.md b/content/desktop/kubernetes.md index 05720e47b7..669edafb70 100644 --- a/content/desktop/kubernetes.md +++ b/content/desktop/kubernetes.md @@ -24,16 +24,15 @@ workloads. 3. Next to **Enable Kubernetes**, select the checkbox. 4. Select **Apply & Restart** to save the settings and then select **Install** to confirm. This instantiates images required to run the Kubernetes server as containers, and installs the `/usr/local/bin/kubectl` command on your machine. - > **Important** + > [!IMPORTANT] > > The `kubectl` binary is not automatically packaged with Docker Desktop for Linux. To install the kubectl command for Linux, see [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/). It should be installed at `/usr/local/bin/kubectl`. - { .important} By default, Kubernetes containers are hidden from commands like `docker ps`, because managing them manually is not supported. Most users do not need this option. To see these internal containers, select **Show system containers (advanced)**. When Kubernetes is turned on and running, an additional status bar in the Docker Dashboard footer and Docker menu displays. -> **Note** +> [!NOTE] > > Docker Desktop does not upgrade your Kubernetes cluster automatically after a new update. To upgrade your Kubernetes cluster to the latest version, select **Reset Kubernetes Cluster**. @@ -52,12 +51,11 @@ $ kubectl config get-contexts $ kubectl config use-context docker-desktop ``` -> **Tip** +> [!TIP] > > Run the `kubectl` command in a CMD or PowerShell terminal, otherwise `kubectl config get-contexts` may return an empty result. > > If you are using a different terminal and this happens, you can try setting the `kubeconfig` environment variable to the location of the `.kube/config` file. -{ .tip } If you installed `kubectl` using Homebrew, or by some other method, and experience conflicts, remove `/usr/local/bin/kubectl`. diff --git a/content/desktop/mac/permission-requirements.md b/content/desktop/mac/permission-requirements.md index 4e8baacd35..b769d75a48 100644 --- a/content/desktop/mac/permission-requirements.md +++ b/content/desktop/mac/permission-requirements.md @@ -108,7 +108,7 @@ refused. ERRO[0003] error waiting for container: context canceled ``` -> **Note** +> [!NOTE] > > The command may fail with the same error if you take too long to authorize the prompt to start the helper process, as it may timeout. diff --git a/content/desktop/networking.md b/content/desktop/networking.md index 4bd912f401..74383f3e4b 100644 --- a/content/desktop/networking.md +++ b/content/desktop/networking.md @@ -54,7 +54,7 @@ See: {{< introduced desktop 4.28.0 "release-notes.md#4280" >}} -> **Note** +> [!NOTE] > > Requires a Business subscription. diff --git a/content/desktop/previous-versions/3.x-mac.md b/content/desktop/previous-versions/3.x-mac.md index b9a7a52600..7f83c022c0 100644 --- a/content/desktop/previous-versions/3.x-mac.md +++ b/content/desktop/previous-versions/3.x-mac.md @@ -422,4 +422,4 @@ Docker Desktop can sometimes fail to start after updating to version 3.2.0. If y ### Known issues - Building an image with BuildKit from a git URL fails when using the form `github.com/org/repo`. To work around this issue, use the form `git://github.com/org/repo`. -- Some DNS addresses fail to resolve within containers based on Alpine Linux 3.13. \ No newline at end of file +- Some DNS addresses fail to resolve within containers based on Alpine Linux 3.13. diff --git a/content/desktop/previous-versions/3.x-windows.md b/content/desktop/previous-versions/3.x-windows.md index eab763866a..2d1f7f90db 100644 --- a/content/desktop/previous-versions/3.x-windows.md +++ b/content/desktop/previous-versions/3.x-windows.md @@ -348,4 +348,4 @@ pgrades ### Known issues - Building an image with BuildKit from a git URL fails when using the form `github.com/org/repo`. To work around this issue, use the form `git://github.com/org/repo`. -- Some DNS addresses fail to resolve within containers based on Alpine Linux 3.13. \ No newline at end of file +- Some DNS addresses fail to resolve within containers based on Alpine Linux 3.13. diff --git a/content/desktop/previous-versions/edge-releases-mac.md b/content/desktop/previous-versions/edge-releases-mac.md index 533d35a9ab..d7c4379d48 100644 --- a/content/desktop/previous-versions/edge-releases-mac.md +++ b/content/desktop/previous-versions/edge-releases-mac.md @@ -391,7 +391,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus 2019-12-11 -> **Note** +> [!NOTE] > > Docker Desktop Edge 2.1.7.0 is the release candidate for the upcoming major Stable release. Please help us test this version before the wider release and report any issues in the [docker/for-mac](https://github.com/docker/for-mac/issues) GitHub repository. diff --git a/content/desktop/previous-versions/edge-releases-windows.md b/content/desktop/previous-versions/edge-releases-windows.md index 2bd361e2f6..38e0c67b33 100644 --- a/content/desktop/previous-versions/edge-releases-windows.md +++ b/content/desktop/previous-versions/edge-releases-windows.md @@ -530,7 +530,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus -> **Note** +> [!NOTE] > > Docker Desktop Edge 2.1.7.0 is the release candidate for the upcoming major Stable release. Please help us test this version before the wider release and report any issues in the [docker/for-win](https://github.com/docker/for-win/issues) GitHub repository. @@ -1276,7 +1276,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus TCP connection is idle for more than 5 minutes (related to [docker/for-mac#1374](https://github.com/docker/for-mac/issues/1374)) -> **Note**: The link above goes to Docker for Mac issues because a +> [!NOTE]: The link above goes to Docker for Mac issues because a Mac user reported this problem, which applied to both Mac and Windows and was fixed on both. diff --git a/content/desktop/release-notes.md b/content/desktop/release-notes.md index f3e50d5fcf..683f849dc5 100644 --- a/content/desktop/release-notes.md +++ b/content/desktop/release-notes.md @@ -1042,7 +1042,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - [Compose v2.20.2](https://github.com/docker/compose/releases/tag/v2.20.2) - [Docker Engine v24.0.5](https://docs.docker.com/engine/release-notes/24.0/#2405) -> **Note** +> [!NOTE] > > In this release, the bundled Docker Compose and Buildx binaries show a different version string. This relates to our efforts to test new features without causing backwards compatibility issues. > diff --git a/content/desktop/settings/linux.md b/content/desktop/settings/linux.md index 9656405490..921af5536f 100644 --- a/content/desktop/settings/linux.md +++ b/content/desktop/settings/linux.md @@ -85,7 +85,6 @@ Advanced settings are: > > If you feel Docker Desktop starting to get slow or you're running > multi-container workloads, increase the memory and disk image space allocation -{ .tip } - **Resource Saver**. Enable or disable [Resource Saver mode](../use-desktop/resource-saver.md), which significantly reduces CPU and memory utilization on the host by @@ -139,7 +138,6 @@ File share settings are: > such as cache directories or databases, the performance will be much > better if they are stored in the Linux VM, using a [data volume](/engine/storage/volumes.md) > (named volume) or [data container](/engine/storage/volumes.md). -{ .tip } ### Proxies @@ -170,7 +168,7 @@ To prevent developers from accidentally changing the proxy settings, see The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY` environment variable. -> **Note** +> [!NOTE] > > If you are using a PAC file hosted on a web server, make sure to add the MIME type `application/x-ns-proxy-autoconfig` for the `.pac` file extension on the server or website. Without this configuration, the PAC file may not be parsed correctly. @@ -200,7 +198,7 @@ You can find this file at `$HOME/.docker/daemon.json`. To change the configurati edit the JSON configuration directly from the dashboard in Docker Desktop, or open and edit the file using your favorite text editor. -> **Note** +> [!NOTE] > > Only the **Docker Desktop** daemon uses the configuration file under `$HOME/.docker`. > If you manually install Docker Engine alongside Docker Desktop, the manually diff --git a/content/desktop/settings/mac.md b/content/desktop/settings/mac.md index 935e1e7f54..b8b812b705 100644 --- a/content/desktop/settings/mac.md +++ b/content/desktop/settings/mac.md @@ -46,16 +46,14 @@ If you choose the integrated terminal, you can run commands in a running contain For more information, see [containerd image store](../containerd.md). - **Use Virtualization framework**. Select to allow Docker Desktop to use the `virtualization.framework` instead of the `hypervisor.framework`. - > **Tip** + > [!TIP] > > Turn this setting on to make Docker Desktop run faster. - { .tip } - **Choose file sharing implementation for your containers**. Choose whether you want to share files using **VirtioFS**, **gRPC FUSE**, or **osxfs**. VirtioFS is only available for macOS versions 12.5 and above, and is turned on by default. >**Tip** > > Use VirtioFS for speedy file sharing. VirtioFS has reduced the time taken to complete filesystem operations by [up to 98%](https://github.com/docker/roadmap/issues/7#issuecomment-1044452206) - { .tip } - **Use Rosetta for x86_64/amd64 emulation on Apple Silicon**. Turns on Rosetta to accelerate x86/AMD64 binary emulation on Apple Silicon. This option is only available if you have turned on **Virtualization framework** in the **General** settings tab. You must also be on macOS Ventura or later. @@ -116,7 +114,6 @@ Advanced settings are: > > If you feel Docker Desktop starting to get slow or you're running > multi-container workloads, increase the memory and disk image space allocation -{ .tip } - **Resource Saver**. Enable or disable [Resource Saver mode](../use-desktop/resource-saver.md), which significantly reduces CPU and memory utilization on the host by @@ -187,7 +184,6 @@ File share settings are: > `Test` will fail. > > For more information, see [Volume mounting requires file sharing for any project directories outside of `/Users`](../troubleshoot/topics.md) -{ .tip } ### Proxies @@ -218,7 +214,7 @@ To prevent developers from accidentally changing the proxy settings, see The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY` environment variable. -> **Note** +> [!NOTE] > > If you are using a PAC file hosted on a web server, make sure to add the MIME type `application/x-ns-proxy-autoconfig` for the `.pac` file extension on the server or website. Without this configuration, the PAC file may not be parsed correctly. diff --git a/content/desktop/settings/windows.md b/content/desktop/settings/windows.md index ba9b3f24d6..785ad8d112 100644 --- a/content/desktop/settings/windows.md +++ b/content/desktop/settings/windows.md @@ -73,7 +73,7 @@ containers. ### Advanced -> **Note** +> [!NOTE] > > The **Resource allocation** options in the **Advanced** tab are only available in Hyper-V mode, because Windows manages > the resources in WSL 2 mode and Windows container mode. In WSL 2 @@ -105,7 +105,6 @@ Advanced settings are: > > If you feel Docker Desktop starting to get slow or you're running > multi-container workloads, increase the memory and disk image space allocation -{ .tip } - **Resource Saver**. Enable or disable [Resource Saver mode](../use-desktop/resource-saver.md), which significantly reduces CPU and memory utilization on the host by @@ -123,7 +122,7 @@ Advanced settings are: ### File sharing -> **Note** +> [!NOTE] > > The **File sharing** tab is only available in Hyper-V mode because the files > are automatically shared in WSL 2 mode and Windows container mode. @@ -179,7 +178,6 @@ File share settings are: > open `Test` will fail with the error "No such file or directory". Similarly, > once a file called `test` is created, attempts to create a second file called > `Test` will fail. -{ .tip } #### Shared folders on demand @@ -222,7 +220,7 @@ The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY If you are running Windows containers in Docker, you can allow the Windows Docker daemon to use Docker Desktop's internal proxy, with the **Use proxy for Windows Docker daemon** setting. This is useful when a corporate proxy that requires authentication is manually configured or set at the system level. If you are an admin for your organization and have a Docker Business subscription, you can control this setting with [Settings management](/security/for-admins/hardened-desktop/settings-management/configure.md) using the `windowsDockerdPort` parameter. -> **Note** +> [!NOTE] > > If you are using a PAC file hosted on a web server, make sure to add the MIME type `application/x-ns-proxy-autoconfig` for the `.pac` file extension on the server or website. Without this configuration, the PAC file may not be parsed correctly. @@ -244,13 +242,13 @@ Developers are no longer interrupted by prompts for proxy credentials as authent If your proxy offers multiple authentication schemes in 407(Proxy Authentication Required) response, Docker Desktop by default selects Basic authentication scheme. If your proxy server is properly configured for Kerberos or NTLM authentication, you can enable Kerberos/NTLM proxy authentication during Docker Desktop installation. To do that, you will have install Docker Deskop from command line and pass the installer flag '--proxy-enable-kerberosntlm'. Available with Docker Desktop 4.32 and later. -> **Note** +> [!NOTE] > > Docker Desktop also supports the use of [SOCKS5 proxies](../networking.md#socks5-proxy-support). ### Network -> **Note** +> [!NOTE] > > The **Network** tab isn't available in the Windows container mode because > Windows manages networking. @@ -304,7 +302,7 @@ Select **Apply & Restart** to save your settings and restart Docker Desktop. ## Kubernetes -> **Note** +> [!NOTE] > > The **Kubernetes** tab is not available in Windows container mode. diff --git a/content/desktop/support.md b/content/desktop/support.md index c6af82c9db..484adca563 100644 --- a/content/desktop/support.md +++ b/content/desktop/support.md @@ -86,4 +86,4 @@ employees who are directly involved in diagnosing Docker Desktop issues. By default, Docker, Inc. will delete uploaded diagnostics bundles after 30 days. You may also request the removal of a diagnostics bundle by either specifying the diagnostics ID or via your GitHub ID (if the diagnostics ID is mentioned in a GitHub issue). Docker, Inc. will only use the data in the diagnostics bundle to investigate specific user issues but may derive high-level (non personal) metrics such as the rate of issues from it. -For more information, see [Docker Data Processing Agreement](https://www.docker.com/legal/data-processing-agreement). \ No newline at end of file +For more information, see [Docker Data Processing Agreement](https://www.docker.com/legal/data-processing-agreement). diff --git a/content/desktop/synchronized-file-sharing.md b/content/desktop/synchronized-file-sharing.md index d630b8d5ff..3c4e37a3b4 100644 --- a/content/desktop/synchronized-file-sharing.md +++ b/content/desktop/synchronized-file-sharing.md @@ -4,7 +4,7 @@ description: Get started with Synchronized file shares on Docker Desktop. keyword: mutagen, file sharing, docker desktop, bind mounts --- -> **Note** +> [!NOTE] > > Synchronized file shares is available with Docker Desktop version 4.27 and later. It is available for customers with a Docker Pro, Team, or Business subscription. @@ -26,14 +26,13 @@ A Synchronized file share behaves just like a virtual file share, but takes adva After creating a file share instance, any container using a bind mount that points to a location on the host filesystem matching the specified synchronized file share location, or a subdirectory within it, utilizes the Synchronized File Shares feature. Bind mounts that don't satisfy this condition are passed to the normal virtual filesystem [bind-mounting mechanism](/engine/storage/bind-mounts.md), for example VirtioFS or gRPC-FUSE. -> **Note** +> [!NOTE] > > Synchronized file shares is not used by Kubernetes' `hostPath` volumes in Docker Desktop. -> **Important** +> [!IMPORTANT] > > Synchronized file shares isn't available on WSL or when using Windows containers. -{ .important } ## Create a file share instance @@ -51,11 +50,10 @@ When the status indicator displays **Watching for filesystem changes**, your fil > > When you create a new service, setting the [bind mount option consistency](../reference/cli/docker/service/create.md#options-for-bind-mounts) to `:consistent` bypasses Synchronized file shares. -> **Tip** +> [!TIP] > > Compose can now automatically create file shares for bind mounts. > Ensure you're signed in to Docker with a paid subscription and have enabled both **Access experimental features** and **Manage Synchronized file shares with Compose** in Docker Desktop's settings. -{ .tip } ## Explore your file share instance diff --git a/content/desktop/troubleshoot/overview.md b/content/desktop/troubleshoot/overview.md index 2fd4d82bf1..5bf9fdd115 100644 --- a/content/desktop/troubleshoot/overview.md +++ b/content/desktop/troubleshoot/overview.md @@ -45,14 +45,13 @@ If you are a Mac or Linux user, you also have the option to **Uninstall** Docker ## Diagnose -> **Tip** +> [!TIP] > > If you do not find a solution in troubleshooting, browse the GitHub repositories or create a new issue: > > - [docker/for-mac](https://github.com/docker/for-mac/issues) > - [docker/for-win](https://github.com/docker/for-win/issues) > - [docker/for-linux](https://github.com/docker/for-linux/issues) -{ .tip } ### Diagnose from the app @@ -63,7 +62,7 @@ This opens the in-app **Support** page and starts collecting the diagnostics. 3. When the diagnostics are uploaded, Docker Desktop prints a diagnostic ID. Copy this ID. 4. Use your diagnostics ID to get help: - If you have a paid Docker subscription, select **Contact Support**. This opens the [Docker Desktop support](https://hub.docker.com/support/desktop/) form. Fill in the information required and add the ID you copied in step three to the **Diagnostics ID** field. Then, select **Submit** to request Docker Desktop support. - > **Note** + > [!NOTE] > > You must be signed in to Docker Desktop to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](../../support/index.md). - If you don't have a paid Docker subscription, select **Report a Bug** to open a new Docker Desktop issue on GitHub. Complete the information required and ensure you add the diagnostic ID you copied in step three. @@ -74,7 +73,7 @@ This opens the in-app **Support** page and starts collecting the diagnostics. 2. When the diagnostics are uploaded, Docker Desktop prints a diagnostic ID. Copy this ID. 3. Use your diagnostics ID to get help: - If you have a paid Docker subscription, you can [contact support](https://hub.docker.com/support/desktop/). Fill in the information required and add the ID you copied in step two to the **Diagnostics ID** field. Then, select **Submit** to request Docker Desktop support. - > **Note** + > [!NOTE] > > You must be signed in to Docker Desktop to access the support form. For information on what's covered as part of Docker Desktop support, see [Support](../../support/index.md). - If you don't have a paid Docker subscription, you can open a new Docker Desktop issue on GitHub for [Mac](https://github.com/docker/for-mac/issues), [Windows](https://github.com/docker/for-win/issues), or [Linux](https://github.com/docker/for-linux/issues). Complete the information required and ensure you add the diagnostic ID you copied in step two. diff --git a/content/desktop/troubleshoot/topics.md b/content/desktop/troubleshoot/topics.md index b98f230efa..eb6a9a1424 100644 --- a/content/desktop/troubleshoot/topics.md +++ b/content/desktop/troubleshoot/topics.md @@ -6,14 +6,13 @@ toc_max: 4 tags: [ Troubleshooting ] --- -> **Tip** +> [!TIP] > > If you do not find a solution in troubleshooting, browse the GitHub repositories or create a new issue: > > - [docker/for-mac](https://github.com/docker/for-mac/issues) > - [docker/for-win](https://github.com/docker/for-win/issues) > - [docker/for-linux](https://github.com/docker/for-linux/issues) -{ .tip } ## Topics for all platforms diff --git a/content/desktop/uninstall.md b/content/desktop/uninstall.md index 0a2ecc6ad2..ac59cb6d64 100644 --- a/content/desktop/uninstall.md +++ b/content/desktop/uninstall.md @@ -4,12 +4,11 @@ keywords: Windows, unintall, Mac, Linux, Docker Desktop title: Uninstall Docker Desktop --- -> **Warning** +> [!WARNING] > > Uninstalling Docker Desktop destroys Docker containers, images, volumes, and > other Docker-related data local to the machine, and removes the files generated > by the application. To learn how to preserve important data before uninstalling, refer to the [back up and restore data](backup-and-restore.md) section . -{ .warning } {{< tabs >}} {{< tab name="Windows" >}} diff --git a/content/desktop/use-desktop/images.md b/content/desktop/use-desktop/images.md index 75767e72a4..af8d0a5d38 100644 --- a/content/desktop/use-desktop/images.md +++ b/content/desktop/use-desktop/images.md @@ -59,7 +59,7 @@ For more information about this view, see [Image details view](/scout/explore/im Select the image from the list, select the **More options** button and select **Pull**. -> **Note** +> [!NOTE] > > The repository must exist on Docker Hub in order to pull the latest version of an image. You must be signed in to pull private images. @@ -67,13 +67,13 @@ Select the image from the list, select the **More options** button and select ** Select the image from the list, select the **More options** button and select **Push to Hub**. -> **Note** +> [!NOTE] > > You can only push an image to Docker Hub if the image belongs to your Docker ID or your organization. That is, the image must contain the correct username/organization in its tag to be able to push it to Docker Hub. ## Remove an image -> **Note** +> [!NOTE] > > To remove an image used by a running or a stopped container, you must first remove the associated container. diff --git a/content/desktop/use-desktop/pause.md b/content/desktop/use-desktop/pause.md index 367ac01ae9..b6abddc429 100644 --- a/content/desktop/use-desktop/pause.md +++ b/content/desktop/use-desktop/pause.md @@ -14,4 +14,3 @@ When you manually pause Docker Desktop, a paused status displays on the Docker m > > The Resource Saver feature, available in Docker Desktop version 4.24 and later, is enabled by default and provides better > CPU and memory savings than the manual Pause feature. See [here](resource-saver.md) for more info. -{ .tip } \ No newline at end of file diff --git a/content/desktop/use-desktop/resource-saver.md b/content/desktop/use-desktop/resource-saver.md index 548839b3fc..f93f20afa4 100644 --- a/content/desktop/use-desktop/resource-saver.md +++ b/content/desktop/use-desktop/resource-saver.md @@ -40,7 +40,7 @@ to zero when Resource Saver mode is on. - Docker commands that don't run containers, for example listing container images or volumes, don't necessarily trigger an exit from Resource Saver mode as Docker Desktop can serve such commands without unnecessarily waking up the Linux VM. -> **Note** +> [!NOTE] > > Docker Desktop exits the Resource Saver mode automatically when it needs to. > Commands that cause an exit from Resource Saver take a little longer to execute diff --git a/content/desktop/use-desktop/volumes.md b/content/desktop/use-desktop/volumes.md index 9656e16ad5..e9bf4ced7e 100644 --- a/content/desktop/use-desktop/volumes.md +++ b/content/desktop/use-desktop/volumes.md @@ -246,4 +246,4 @@ To import a volume: ## Additional resources - [Persisting container data](../../guides/docker-concepts/running-containers/persisting-container-data.md) -- [Use volumes](/engine/storage/volumes.md) \ No newline at end of file +- [Use volumes](/engine/storage/volumes.md) diff --git a/content/desktop/vm-vdi.md b/content/desktop/vm-vdi.md index 149aab6f9b..36433d9eec 100644 --- a/content/desktop/vm-vdi.md +++ b/content/desktop/vm-vdi.md @@ -12,7 +12,7 @@ To run Docker Desktop in a virtual desktop environment, it is essential nested v ## Virtual desktop support -> **Note** +> [!NOTE] > > Support for running Docker Desktop on a virtual desktop is available to Docker Business customers, on VMware ESXi or Azure VMs only. diff --git a/content/desktop/wsl/_index.md b/content/desktop/wsl/_index.md index 8e44e0f717..ab4f466e61 100644 --- a/content/desktop/wsl/_index.md +++ b/content/desktop/wsl/_index.md @@ -31,14 +31,12 @@ Before you turn on the Docker Desktop WSL 2 feature, ensure you have: > setting available since WSL 1.3.10 (experimental). > > This feature enhances the Windows host's ability to reclaim unused memory within the WSL virtual machine, ensuring improved memory availability for other host applications. This capability is especially beneficial for Docker Desktop, as it prevents the WSL VM from retaining large amounts of memory (in GBs) within the Linux kernel's page cache during Docker container image builds, without releasing it back to the host when no longer needed within the VM. -{ .tip } ## Turn on Docker Desktop WSL 2 -> **Important** +> [!IMPORTANT] > > To avoid any potential conflicts with using WSL 2 on Docker Desktop, you must uninstall any previous versions of Docker Engine and CLI installed directly through Linux distributions before installing Docker Desktop. -{ .important } 1. Download and install the latest version of [Docker Desktop for Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe). 2. Follow the usual installation instructions to install Docker Desktop. Depending on which version of Windows you are using, Docker Desktop may prompt you to turn on WSL 2 during installation. Read the information displayed on the screen and turn on the WSL 2 feature to continue. @@ -56,7 +54,6 @@ Now `docker` commands work from Windows using the new WSL 2 engine. > By default, Docker Desktop stores the data for the WSL 2 engine at `C:\Users\[USERNAME]\AppData\Local\Docker\wsl`. > If you want to change the location, for example, to another drive you can do so via the `Settings -> Resources -> Advanced` page from the Docker Dashboard. > Read more about this and other Windows settings at [Changing Docker Desktop settings on Windows](../settings/windows.md) -{ .tip } ## Enabling Docker support in WSL 2 distros @@ -93,7 +90,7 @@ Docker Desktop does not require any particular Linux distros to be installed. Th 3. Select **Apply & Restart**. -> **Note** +> [!NOTE] > > Docker Desktop installs two special-purpose internal Linux distros `docker-desktop` and `docker-desktop-data`. The first (`docker-desktop`) is used to run the Docker engine (`dockerd`) while the second (`docker-desktop-data`) stores containers and images. Neither can be used for general development. diff --git a/content/docker-hub/api/deprecated.md b/content/docker-hub/api/deprecated.md index 90b4006cc4..26cde3fe79 100644 --- a/content/docker-hub/api/deprecated.md +++ b/content/docker-hub/api/deprecated.md @@ -7,7 +7,6 @@ title: Docker Hub API v1 (deprecated) > **Deprecated** > > Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead. -{ .warning } The following API routes within the v1 path will no longer work and will return a 410 status code: * `/v1/repositories/{name}/images` @@ -26,4 +25,4 @@ If you want to continue using the Docker Hub API in your current applications, u | [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) | | [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) | | [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | -| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | \ No newline at end of file +| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | diff --git a/content/docker-hub/api/dvp.md b/content/docker-hub/api/dvp.md index 7f901918bf..f2831098d1 100644 --- a/content/docker-hub/api/dvp.md +++ b/content/docker-hub/api/dvp.md @@ -1,3 +1,3 @@ --- layout: hub-api ---- \ No newline at end of file +--- diff --git a/content/docker-hub/api/latest.md b/content/docker-hub/api/latest.md index 7f901918bf..f2831098d1 100644 --- a/content/docker-hub/api/latest.md +++ b/content/docker-hub/api/latest.md @@ -1,3 +1,3 @@ --- layout: hub-api ---- \ No newline at end of file +--- diff --git a/content/docker-hub/builds/_index.md b/content/docker-hub/builds/_index.md index 4c59a0d885..2ffc922c01 100644 --- a/content/docker-hub/builds/_index.md +++ b/content/docker-hub/builds/_index.md @@ -7,7 +7,7 @@ aliases: - /docker-hub/builds/classic/ --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -114,7 +114,7 @@ For each source: * Specify the **Dockerfile location** as a path relative to the root of the source code repository. If the Dockerfile is at the repository root, leave this path set to `/`. -> **Note** +> [!NOTE] > > When Docker Hub pulls a branch from a source code repository, it performs a > shallow clone - only the tip of the specified branch. Refer to @@ -133,7 +133,7 @@ commands you set in `hooks` files. However, they're stored so that only users wh means you can use them to store access tokens or other information that should remain secret. -> **Note** +> [!NOTE] > > The variables set on the build configuration screen are used during > the build processes only and shouldn't get confused with the environment @@ -192,7 +192,7 @@ the case, you can specify a path where the build looks for the files. The build context is the path to the files needed for the build, relative to the root of the repository. Enter the path to these files in the **Build context** field. Enter `/` to set the build context as the root of the source code repository. -> **Note** +> [!NOTE] > > If you delete the default path `/` from the **Build context** field and leave > it blank, the build system uses the path to the Dockerfile as the build @@ -250,7 +250,7 @@ including any testing settings. ### Service users for team autobuilds -> **Note** +> [!NOTE] > > Only owners can set up Automated builds for teams. @@ -284,7 +284,7 @@ variable to automated builds associated with the account. For more information, 5. Sign in to Docker Hub as an owner, switch to the organization, and follow the instructions to [link to source code repository](link-source.md) using the service account. - > **Note** + > [!NOTE] > > You may need to log out of your individual account on the source code provider to create the link to the service account. diff --git a/content/docker-hub/builds/advanced.md b/content/docker-hub/builds/advanced.md index 585c068058..e1372a28e2 100644 --- a/content/docker-hub/builds/advanced.md +++ b/content/docker-hub/builds/advanced.md @@ -4,7 +4,7 @@ keywords: automated, build, images title: Advanced options for Autobuild and Autotest --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -18,7 +18,7 @@ Several utility environment variables are set by the build process, and are available during automated builds, automated tests, and while executing hooks. -> **Note** +> [!NOTE] > > These environment variables are only available to the build and test processes and don't affect your service's run environment. @@ -53,12 +53,11 @@ might use a build hook to set build arguments used only during the build process. You can also set up [custom build phase hooks](#custom-build-phase-hooks) to perform actions in between these commands. -> **Important** +> [!IMPORTANT] > >Use these hooks with caution. The contents of these hook files replace the basic `docker` commands, so you must include a similar build, test or push command in the hook or your automated process does not complete. -{ .important } To override these phases, create a folder called `hooks` in your source code repository at the same directory level as your Dockerfile. Create a file called @@ -111,11 +110,10 @@ of the image being built. $ docker build --build-arg CUSTOM=$VAR -f $DOCKERFILE_PATH -t $IMAGE_NAME . ``` -> **Important** +> [!IMPORTANT] > > A `hooks/build` file overrides the basic `docker build` command used by the builder, so you must include a similar build command in the hook or the automated build fails. -{ .important } Refer to the [docker build documentation](../../reference/cli/docker/buildx/build.md#build-arg) to learn more about Docker build-time variables. diff --git a/content/docker-hub/builds/automated-testing.md b/content/docker-hub/builds/automated-testing.md index be9a78662f..eb0f26d643 100644 --- a/content/docker-hub/builds/automated-testing.md +++ b/content/docker-hub/builds/automated-testing.md @@ -4,7 +4,7 @@ keywords: Automated, testing, repository title: Automated repository tests --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -41,7 +41,7 @@ You can define any number of linked services in this file. The only requirement is that `sut` is defined. Its return code determines if tests passed or not. Tests pass if the `sut` service returns `0`, and fail otherwise. -> **Note** +> [!NOTE] > > Only the `sut` service and all other services listed in > [`depends_on`](../../compose/compose-file/05-services.md#depends_on) are @@ -54,7 +54,7 @@ that ends in `.test.yml` is used for testing, and the tests run sequentially. You can also use [custom build hooks](advanced.md#override-build-test-or-push-commands) to further customize your test behavior. -> **Note** +> [!NOTE] > > If you enable Automated builds, they also run any tests defined in the `test.yml` files. @@ -101,13 +101,12 @@ Docker repository, regardless of the Autotest settings. pull requests to branches that match a build rule, including when the pull request originated in an external source repository. - > **Important** + > [!IMPORTANT] > >For security purposes, autotest on external pull requests is limited on public repositories. Private images are not pulled and environment variables defined in Docker Hub are not available. Automated builds continue to work as usual. - { .important } 7. Select **Save** to save the settings, or select **Save and build** to save and run an initial test. diff --git a/content/docker-hub/builds/how-builds-work.md b/content/docker-hub/builds/how-builds-work.md index 8187a9b52b..17a7ac22cf 100644 --- a/content/docker-hub/builds/how-builds-work.md +++ b/content/docker-hub/builds/how-builds-work.md @@ -4,7 +4,7 @@ keywords: docker hub, automated builds title: How Automated builds work --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -20,7 +20,7 @@ to a source-code branch, for example in GitHub, for one of those listed image tags, the push uses a webhook to trigger a new build, which produces a Docker image. The built image is then pushed to Docker Hub. -> **Note** +> [!NOTE] > > You can still use `docker push` to push pre-built images to repositories with Automated builds configured. diff --git a/content/docker-hub/builds/link-source.md b/content/docker-hub/builds/link-source.md index 79b3e48580..645e1f9ce8 100644 --- a/content/docker-hub/builds/link-source.md +++ b/content/docker-hub/builds/link-source.md @@ -8,7 +8,7 @@ aliases: - /docker-hub/bitbucket/ --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -109,7 +109,7 @@ from Docker Hub, and from your GitHub account. 5. Select the `...` menu to the right of the Docker Hub Builder application and select **Revoke**. -> **Note** +> [!NOTE] > > Each repository that is configured as an automated build source contains a webhook that notifies Docker Hub of changes in the repository. @@ -146,7 +146,7 @@ unlink it both from Docker Hub, and from your Bitbucket account. 6. Select **Revoke** next to the Docker Hub line. -> **Note** +> [!NOTE] > > Each repository that is configured as an automated build source contains a webhook that notifies Docker Hub of changes in the repository. This diff --git a/content/docker-hub/builds/manage-builds.md b/content/docker-hub/builds/manage-builds.md index 38b1c2d232..46ef26d690 100644 --- a/content/docker-hub/builds/manage-builds.md +++ b/content/docker-hub/builds/manage-builds.md @@ -4,7 +4,7 @@ description: How to manage autobuilds in Docker Hub keywords: autobuilds, automated, docker hub, registry --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -57,4 +57,4 @@ to automatically build. 4. Select the **Autobuild** toggle next to the configuration line. When disabled the toggle is gray. -5. Select **Save**. \ No newline at end of file +5. Select **Save**. diff --git a/content/docker-hub/builds/troubleshoot.md b/content/docker-hub/builds/troubleshoot.md index 6f8739b8d4..6f55c8acec 100644 --- a/content/docker-hub/builds/troubleshoot.md +++ b/content/docker-hub/builds/troubleshoot.md @@ -5,7 +5,7 @@ keywords: docker hub, troubleshoot, automated builds, autobuilds tags: [ Troubleshooting ] --- -> **Note** +> [!NOTE] > > Automated builds require a > [Docker Pro, Team, or Business subscription](../../subscription/index.md). @@ -17,7 +17,7 @@ If a build fails, a **Retry** icon appears next to the build report line on the ![Timeline view showing the retry build button](images/retry-build.png) -> **Note** +> [!NOTE] > > If you are viewing the build details for a repository that belongs to an > organization, the **Cancel** and **Retry** buttons only appear if you have `Read & Write` access to the repository. @@ -46,7 +46,7 @@ To work around this, you can set up your automated build using the `SSH_PRIVATE` environment variable to override the deployment key and grant Docker Hub's build system access to the repositories. -> **Note** +> [!NOTE] > > If you are using autobuild for teams, use the process below > instead, and configure a service user for your source code provider. You can @@ -64,7 +64,7 @@ system access to the repositories. 6. Paste the private half of the keypair into the **Value** field. 7. Select **Save**, or **Save and Build** to validate that the build now completes. -> **Note** +> [!NOTE] > > You must configure your private git submodules using git clone over SSH > (`git@submodule.tld:some-submodule.git`) rather than HTTPS. diff --git a/content/docker-hub/mirror.md b/content/docker-hub/mirror.md index fdff8abfde..c026d3dcdd 100644 --- a/content/docker-hub/mirror.md +++ b/content/docker-hub/mirror.md @@ -16,7 +16,7 @@ to the internet and fetches an image it doesn't have locally, from the Docker repository. You can run a local registry mirror and point all your daemons there, to avoid this extra internet traffic. -> **Note** +> [!NOTE] > > Docker Official Images are an intellectual property of Docker. @@ -33,7 +33,7 @@ relying entirely on your local registry is the simplest scenario. It's currently not possible to mirror another private registry. Only the central Hub can be mirrored. -> **Note** +> [!NOTE] > > Mirrors of Docker Hub are still subject to Docker's [fair usage policy](https://www.docker.com/pricing/resource-consumption-updates). @@ -76,7 +76,7 @@ Multiple registry caches can be deployed over the same back-end. A single registry cache ensures that concurrent requests do not pull duplicate data, but this property does not hold true for a registry cache cluster. -> **Note** +> [!NOTE] > > When using Docker Hub, all paid Docker subscriptions are limited to 5000 pulls per day. If you require a higher number of pulls, you can purchase an Enhanced Service Account add-on. See [Service Accounts](/docker-hub/service-accounts/) for more details. @@ -95,19 +95,17 @@ proxy: password: [password] ``` -> **Warning** +> [!WARNING] > > If you specify a username and password, it's very important to understand that > private resources that this user has access to Docker Hub is made available on > your mirror. You must secure your mirror by implementing authentication if > you expect these resources to stay private! -{ .warning } -> **Warning** +> [!WARNING] > > For the scheduler to clean up old entries, `delete` must be enabled in the > registry configuration. -{ .warning } ### Configure the Docker daemon @@ -123,7 +121,7 @@ and add the `registry-mirrors` key and value, to make the change persistent. Save the file and reload Docker for the change to take effect. -> **Note** +> [!NOTE] > > Some log messages that appear to be errors are actually informational > messages. diff --git a/content/docker-hub/oci-artifacts.md b/content/docker-hub/oci-artifacts.md index 00e3d241de..b1d9f4b87e 100644 --- a/content/docker-hub/oci-artifacts.md +++ b/content/docker-hub/oci-artifacts.md @@ -174,4 +174,4 @@ Steps: 4. Go to the repository page on Docker Hub. The **Tags** section on that page shows the artifact tag. - ![Repository page showing an artifact in the tag list](./images/oci-artifact.png) \ No newline at end of file + ![Repository page showing an artifact in the tag list](./images/oci-artifact.png) diff --git a/content/docker-hub/quickstart.md b/content/docker-hub/quickstart.md index 614131b70b..58e04e318c 100644 --- a/content/docker-hub/quickstart.md +++ b/content/docker-hub/quickstart.md @@ -13,10 +13,9 @@ Start by creating a [Docker ID](https://hub.docker.com/signup). A [Docker ID](/accounts/create-account/) grants you access to Docker Hub repositories and lets you explore available images from the community and verified publishers. You also need a Docker ID to share images on Docker Hub. -> **Tip** +> [!TIP] > > Explore [Docker's core subscriptions](https://www.docker.com/pricing/) to see what else Docker can offer you. -{ .tip } ### Step 2: Create your first repository diff --git a/content/docker-hub/release-notes.md b/content/docker-hub/release-notes.md index 61787e8bdd..27b5fd6757 100644 --- a/content/docker-hub/release-notes.md +++ b/content/docker-hub/release-notes.md @@ -213,7 +213,6 @@ to `hub.docker.com`. You can access the page at its new URL: [https://hub.docker > If you lose both your 2FA authentication device and recovery code, you may > not be able to recover your account. - { .important } ### Enhancements diff --git a/content/docker-hub/repos/_index.md b/content/docker-hub/repos/_index.md index a18d3954f3..e97f9dcead 100644 --- a/content/docker-hub/repos/_index.md +++ b/content/docker-hub/repos/_index.md @@ -77,12 +77,11 @@ The private images that existed in your user account are now available for your ## Delete a repository -> **Warning** +> [!WARNING] > > Deleting a repository deletes all the images it contains and its build settings. This action can't be undone. -{ .warning } 1. Navigate to your repository. 2. Select the **Settings** tab. 3. Select **Delete repository**. -4. Enter the name of your repository to confirm. \ No newline at end of file +4. Enter the name of your repository to confirm. diff --git a/content/docker-hub/repos/access.md b/content/docker-hub/repos/access.md index 6622bef9d0..3cf92798e7 100644 --- a/content/docker-hub/repos/access.md +++ b/content/docker-hub/repos/access.md @@ -17,7 +17,7 @@ Only personal account repositories can use collaborators. You can add unlimited You can choose collaborators and manage their access to a private repository from that repository's **Settings** page. -> **Note** +> [!NOTE] > > A collaborator can't add other collaborators. Only the owner of > the repository has administrative access. @@ -32,7 +32,7 @@ You can view the available tags and the size of the associated image. Go to the To delete a tag, select the corresponding checkbox and select **Delete** from the **Action** drop-down list. -> **Note** +> [!NOTE] > > Only a user with administrative access (owner or team member with Admin > permission) over the repository can delete tags. diff --git a/content/docker-hub/repos/categories.md b/content/docker-hub/repos/categories.md index dfa46330bb..d72d738097 100644 --- a/content/docker-hub/repos/categories.md +++ b/content/docker-hub/repos/categories.md @@ -33,7 +33,7 @@ The available categories are: ## Auto-generated categories -> **Note** +> [!NOTE] > > Auto-generated categories only apply to Docker Verified Publishers and > Docker-Sponsored Open Source program participants. diff --git a/content/docker-hub/repos/create.md b/content/docker-hub/repos/create.md index e8545e59a0..37795c4935 100644 --- a/content/docker-hub/repos/create.md +++ b/content/docker-hub/repos/create.md @@ -28,7 +28,7 @@ When creating a new repository: - Have between 2 and 255 characters - Only contain lowercase letters, numbers, hyphens (`-`), and underscores (`_`) - > **Note** + > [!NOTE] > > You can't rename a Docker Hub repository once it's created. @@ -38,7 +38,7 @@ When creating a new repository: the repository settings. - You can set the repository's default visibility to public or private. - > **Note** + > [!NOTE] > > For organizations creating a new repository, it's recommended you select **Private**. diff --git a/content/docker-hub/service-accounts.md b/content/docker-hub/service-accounts.md index 8e5f83451d..18e3a2ea34 100644 --- a/content/docker-hub/service-accounts.md +++ b/content/docker-hub/service-accounts.md @@ -4,14 +4,14 @@ keywords: Docker, service, accounts, Docker Hub title: Service accounts --- -> **Note** +> [!NOTE] > > Service accounts require a > [Docker Team, or Business subscription](../subscription/index.md). A service account is a Docker ID used for automated management of container images or containerized applications. Service accounts are typically used in automated workflows, and don't share Docker IDs with the members in the organization. Common use cases for service accounts include mirroring content on Docker Hub, or tying in image pulls from your CI/CD process. -> **Note** +> [!NOTE] > > All paid Docker subscriptions include up to 5000 pulls per day per authenticated user. If you require a higher number of pulls, you can purchase an Enhanced Service Account add-on. @@ -48,7 +48,7 @@ To create a new service account for your Team account: 4. Add the new Docker ID to the [team](manage-a-team.md) you created earlier. 5. Create a new [personal access token (PAT)](access-tokens.md) from the user account and use it for CI. -> **Note** +> [!NOTE] > > If you want a read-only PAT just for your open-source repositories, or to access official images and other public images, you don't have to grant any access permissions to the new Docker ID. diff --git a/content/docker-hub/vulnerability-scanning.md b/content/docker-hub/vulnerability-scanning.md index 6f35e50a29..7056a9bd95 100644 --- a/content/docker-hub/vulnerability-scanning.md +++ b/content/docker-hub/vulnerability-scanning.md @@ -4,7 +4,7 @@ keywords: scanning, vulnerabilities, Hub, static title: Static vulnerability scanning --- -> **Note** +> [!NOTE] > > This page describes the legacy static vulnerability scanning feature of > Docker Hub. There's also [Docker Scout](../scout/_index.md), which provides @@ -56,7 +56,7 @@ Docker Hub. Additionally, repository owners in a Docker Pro subscription and team members in a Team, or a Business subscription can view the detailed scan reports. -> **Note** +> [!NOTE] > > Static vulnerability scanning supports scanning images which are of AMD64 > architecture, Linux OS, and are less than 10 GB in size. diff --git a/content/engine/api/_index.md b/content/engine/api/_index.md index 80d1462518..4d47ca3fe0 100644 --- a/content/engine/api/_index.md +++ b/content/engine/api/_index.md @@ -52,7 +52,7 @@ A given version of the Docker Engine SDK supports a specific version of the Docker Engine API, as well as all earlier versions. If breaking changes occur, they are documented prominently. -> **Note** +> [!NOTE] > > The Docker daemon and client don't necessarily need to be the same version > at all times. However, keep the following in mind. diff --git a/content/engine/api/sdk/_index.md b/content/engine/api/sdk/_index.md index 9a404cd87c..9828c25378 100644 --- a/content/engine/api/sdk/_index.md +++ b/content/engine/api/sdk/_index.md @@ -162,7 +162,7 @@ hello world When using cURL to connect over a Unix socket, the hostname is not important. The previous examples use `localhost`, but any hostname would work. -> **Important** +> [!IMPORTANT] > > The previous examples assume you're using cURL 7.50.0 or above. Older versions of > cURL used a [non-standard URL notation](https://github.com/moby/moby/issues/17960) @@ -170,7 +170,6 @@ examples use `localhost`, but any hostname would work. > > If you're' using an older version of cURL, use `http://` instead, > for example: `http:/v{{% param "latest_engine_api_version" %}}/containers/1c6594faf5/start`. -{ .important } {{< /tab >}} {{< /tabs >}} diff --git a/content/engine/api/sdk/examples.md b/content/engine/api/sdk/examples.md index c289112416..d1e863b09c 100644 --- a/content/engine/api/sdk/examples.md +++ b/content/engine/api/sdk/examples.md @@ -125,7 +125,7 @@ hello world When using cURL to connect over a Unix socket, the hostname isn't important. The previous examples use `localhost`, but any hostname would work. -> **Important** +> [!IMPORTANT] > > The previous examples assume you're using cURL 7.50.0 or above. Older versions of > cURL used a [non-standard URL notation](https://github.com/moby/moby/issues/17960) @@ -133,7 +133,6 @@ previous examples use `localhost`, but any hostname would work. > > If you're' using an older version of cURL, use `http://` instead, > for example: `http:/v{{% param "latest_engine_api_version" %}}/containers/1c6594faf5/start`. -{ .important } {{< /tab >}} {{< /tabs >}} @@ -286,7 +285,7 @@ $ curl --unix-socket /var/run/docker.sock http://localhost/v{{% param "latest_en Now that you know what containers exist, you can perform operations on them. This example stops all running containers. -> **Note** +> [!NOTE] > > Don't run this on a production server. Also, if you're' using swarm > services, the containers stop, but Docker creates new ones to keep @@ -553,7 +552,7 @@ $ curl --unix-socket /var/run/docker.sock \ Pull an image, like `docker pull`, with authentication: -> **Note** +> [!NOTE] > > Credentials are sent in the clear. Docker's official registries use > HTTPS. Private registries should also be configured to use HTTPS. diff --git a/content/engine/api/v1.25.md b/content/engine/api/v1.25.md index 31d4f17e54..20fcf69eed 100644 --- a/content/engine/api/v1.25.md +++ b/content/engine/api/v1.25.md @@ -2,4 +2,4 @@ layout: engine-api aliases: - /engine/reference/api/docker_remote_api_v1.25/ ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.26.md b/content/engine/api/v1.26.md index 0b5443338b..8709874883 100644 --- a/content/engine/api/v1.26.md +++ b/content/engine/api/v1.26.md @@ -2,4 +2,4 @@ layout: engine-api aliases: - /engine/reference/api/docker_remote_api_v1.26/ ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.27.md b/content/engine/api/v1.27.md index f5f2217957..c6465489d6 100644 --- a/content/engine/api/v1.27.md +++ b/content/engine/api/v1.27.md @@ -2,4 +2,4 @@ layout: engine-api aliases: - /engine/reference/api/docker_remote_api_v1.27/ ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.28.md b/content/engine/api/v1.28.md index b27f524273..18a35b4526 100644 --- a/content/engine/api/v1.28.md +++ b/content/engine/api/v1.28.md @@ -2,4 +2,4 @@ layout: engine-api aliases: - /engine/reference/api/docker_remote_api_v1.28/ ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.29.md b/content/engine/api/v1.29.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.29.md +++ b/content/engine/api/v1.29.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.30.md b/content/engine/api/v1.30.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.30.md +++ b/content/engine/api/v1.30.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.31.md b/content/engine/api/v1.31.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.31.md +++ b/content/engine/api/v1.31.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.32.md b/content/engine/api/v1.32.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.32.md +++ b/content/engine/api/v1.32.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.33.md b/content/engine/api/v1.33.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.33.md +++ b/content/engine/api/v1.33.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.34.md b/content/engine/api/v1.34.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.34.md +++ b/content/engine/api/v1.34.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.35.md b/content/engine/api/v1.35.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.35.md +++ b/content/engine/api/v1.35.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.36.md b/content/engine/api/v1.36.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.36.md +++ b/content/engine/api/v1.36.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.37.md b/content/engine/api/v1.37.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.37.md +++ b/content/engine/api/v1.37.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.38.md b/content/engine/api/v1.38.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.38.md +++ b/content/engine/api/v1.38.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.39.md b/content/engine/api/v1.39.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.39.md +++ b/content/engine/api/v1.39.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.40.md b/content/engine/api/v1.40.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.40.md +++ b/content/engine/api/v1.40.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.41.md b/content/engine/api/v1.41.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.41.md +++ b/content/engine/api/v1.41.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.42.md b/content/engine/api/v1.42.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.42.md +++ b/content/engine/api/v1.42.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.43.md b/content/engine/api/v1.43.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.43.md +++ b/content/engine/api/v1.43.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/api/v1.44.md b/content/engine/api/v1.44.md index caa6d1129b..4b058956a8 100644 --- a/content/engine/api/v1.44.md +++ b/content/engine/api/v1.44.md @@ -1,3 +1,3 @@ --- layout: engine-api ---- \ No newline at end of file +--- diff --git a/content/engine/cli/formatting.md b/content/engine/cli/formatting.md index 2872bd183b..09a475f940 100644 --- a/content/engine/cli/formatting.md +++ b/content/engine/cli/formatting.md @@ -15,7 +15,7 @@ All of these examples use the `docker inspect` command, but many other CLI commands have a `--format` flag, and many of the CLI command references include examples of customizing the output format. -> **Note** +> [!NOTE] > > When using the `--format` flag, you need observe your shell environment. > In a POSIX shell, you can run the following with a single quote: @@ -31,7 +31,6 @@ include examples of customizing the output format. > $ docker inspect --format '{{join .Args \" , \"}}' > ``` > -{ .important } ## join diff --git a/content/engine/cli/proxy.md b/content/engine/cli/proxy.md index 2619cae6b7..d3f132792a 100644 --- a/content/engine/cli/proxy.md +++ b/content/engine/cli/proxy.md @@ -25,7 +25,7 @@ configure it in different ways: - [Configure the Docker client](#configure-the-docker-client) - [Set proxy using the CLI](#set-proxy-using-the-cli) -> **Note** +> [!NOTE] > > Unfortunately, there's no standard that defines how web clients should handle proxy > environment variables, or the format for defining them. @@ -52,7 +52,7 @@ Builds and containers use the configuration specified in this file. } ``` -> **Warning** +> [!WARNING] > > Proxy settings may contain sensitive information. For example, some proxy servers > require authentication information to be included in their URL, or their @@ -61,7 +61,6 @@ Builds and containers use the configuration specified in this file. > Environment variables are stored as plain text in the container's configuration, > and as such can be inspected through the remote API or committed to an image > when using `docker commit`. -{ .warning } The configuration becomes active after saving the file, you don't need to restart Docker. However, the configuration only applies to new containers and diff --git a/content/engine/containers/live-restore.md b/content/engine/containers/live-restore.md index 6fff9791a7..92ec56e68e 100644 --- a/content/engine/containers/live-restore.md +++ b/content/engine/containers/live-restore.md @@ -13,7 +13,7 @@ becomes unavailable. This functionality is called _live restore_. The live resto option helps reduce container downtime due to daemon crashes, planned outages, or upgrades. -> **Note** +> [!NOTE] > > Live restore isn't supported for Windows containers, but it does work for > Linux containers running on Docker Desktop for Windows. diff --git a/content/engine/containers/resource_constraints.md b/content/engine/containers/resource_constraints.md index a4b445ed74..ddbc45e2fa 100644 --- a/content/engine/containers/resource_constraints.md +++ b/content/engine/containers/resource_constraints.md @@ -210,12 +210,11 @@ can't use the CFS scheduler. You need to before you can [configure the Docker daemon](#configure-the-docker-daemon) or [configure individual containers](#configure-individual-containers). -> **Warning** +> [!WARNING] > > CPU scheduling and prioritization are advanced kernel-level features. Most > users don't need to change these values from their defaults. Setting these > values incorrectly can cause your host system to become unstable or unusable. -{ .warning } #### Configure the host machine's kernel @@ -322,7 +321,7 @@ $ docker run -it --rm --gpus '"device=0,2"' ubuntu nvidia-smi Exposes the first and third GPUs. -> **Note** +> [!NOTE] > > NVIDIA GPUs can only be accessed by systems running a single engine. diff --git a/content/engine/containers/runmetrics.md b/content/engine/containers/runmetrics.md index 4324287fc5..911cfafe86 100644 --- a/content/engine/containers/runmetrics.md +++ b/content/engine/containers/runmetrics.md @@ -138,7 +138,7 @@ container, take a look at the following paths: ### Metrics from cgroups: memory, CPU, block I/O -> **Note** +> [!NOTE] > > This section isn't yet updated for cgroup v2. > For further information about cgroup v2, refer to [the kernel documentation](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html). diff --git a/content/engine/containers/start-containers-automatically.md b/content/engine/containers/start-containers-automatically.md index 126d889abf..771dc907f5 100644 --- a/content/engine/containers/start-containers-automatically.md +++ b/content/engine/containers/start-containers-automatically.md @@ -143,11 +143,10 @@ Docker depend on Docker containers, you can use a process manager such as [systemd](https://systemd.io/) or [supervisor](http://supervisord.org/) instead. -> **Warning** +> [!WARNING] > > Don't combine Docker restart policies with host-level process managers, > as this creates conflicts. -{ .warning } To use a process manager, configure it to start your container or service using the same `docker start` or `docker service` command you would normally use to @@ -159,10 +158,9 @@ process manager for more details. Process managers can also run within the container to check whether a process is running and starts/restart it if not. -> **Warning** +> [!WARNING] > > These aren't Docker-aware, and only monitor operating system processes within > the container. Docker doesn't recommend this approach, because it's > platform-dependent and may differ between versions of a given Linux > distribution. -{ .warning } diff --git a/content/engine/daemon/_index.md b/content/engine/daemon/_index.md index 9d90442f41..ced09ab099 100644 --- a/content/engine/daemon/_index.md +++ b/content/engine/daemon/_index.md @@ -28,7 +28,7 @@ aliases: This page shows you how to customize the Docker daemon, `dockerd`. -> **Note** +> [!NOTE] > > This page is for users who've installed Docker Engine manually. If you're > using Docker Desktop, refer to the following pages instead: diff --git a/content/engine/daemon/alternative-runtimes.md b/content/engine/daemon/alternative-runtimes.md index 783a5e86d1..088159d9bf 100644 --- a/content/engine/daemon/alternative-runtimes.md +++ b/content/engine/daemon/alternative-runtimes.md @@ -178,7 +178,7 @@ To add Wasmtime as a container runtime, follow these steps: 1. Turn on the [containerd image store](/engine/storage/containerd.md) feature in the daemon configuration file. - > **Note** + > [!NOTE] > > This is an experimental feature. diff --git a/content/engine/daemon/ipv6.md b/content/engine/daemon/ipv6.md index 4a33a8f1dc..d7b61ac6f2 100644 --- a/content/engine/daemon/ipv6.md +++ b/content/engine/daemon/ipv6.md @@ -166,7 +166,7 @@ size `/64`, from an IPv6 pool of prefix length `/56`. } ``` -> **Note** +> [!NOTE] > > The address `2001:db8::` in this example is > [reserved for use in documentation][wikipedia-ipv6-reserved]. diff --git a/content/engine/daemon/logs.md b/content/engine/daemon/logs.md index d1e5a5f788..0b09f3e8e3 100644 --- a/content/engine/daemon/logs.md +++ b/content/engine/daemon/logs.md @@ -108,7 +108,7 @@ The Docker daemon log can be viewed by using one of the following methods: - `/var/log/messages`, `/var/log/daemon.log`, or `/var/log/docker.log` on older Linux systems -> **Note** +> [!NOTE] > > It isn't possible to manually generate a stack trace on Docker Desktop for > Mac or Docker Desktop for Windows. However, you can click the Docker taskbar diff --git a/content/engine/daemon/prometheus.md b/content/engine/daemon/prometheus.md index dc42df8872..a4dbdeb621 100644 --- a/content/engine/daemon/prometheus.md +++ b/content/engine/daemon/prometheus.md @@ -12,11 +12,10 @@ aliases: [Prometheus](https://prometheus.io/) is an open-source systems monitoring and alerting toolkit. You can configure Docker as a Prometheus target. -> **Warning** +> [!WARNING] > > The available metrics and the names of those metrics are in active > development and may change at any time. -{ .warning } Currently, you can only monitor Docker itself. You can't currently monitor your application using the Docker target. @@ -119,7 +118,7 @@ Verify that the Docker target is listed at `http://localhost:9090/targets/`. ![Prometheus targets page](images/prometheus-targets.webp) -> **Note** +> [!NOTE] > > You can't access the endpoint URLs on this page directly if you use Docker > Desktop. diff --git a/content/engine/daemon/proxy.md b/content/engine/daemon/proxy.md index d494841e6b..5ef502cecc 100644 --- a/content/engine/daemon/proxy.md +++ b/content/engine/daemon/proxy.md @@ -112,7 +112,7 @@ systemd drop-in file that sets the variables for the `docker` service. Environment="HTTPS_PROXY=https://proxy.example.com:3129" ``` - > **Note** + > [!NOTE] > > Special characters in the proxy value, such as `#?!()[]{}`, must be double > escaped using `%%`. For example: @@ -199,7 +199,7 @@ systemd drop-in file that sets the variables for the `docker` service. Environment="HTTPS_PROXY=https://proxy.example.com:3129" ``` - > **Note** + > [!NOTE] > > Special characters in the proxy value, such as `#?!()[]{}`, must be double > escaped using `%%`. For example: diff --git a/content/engine/daemon/remote-access.md b/content/engine/daemon/remote-access.md index f41a41a43a..45bffbba40 100644 --- a/content/engine/daemon/remote-access.md +++ b/content/engine/daemon/remote-access.md @@ -15,7 +15,7 @@ from remote clients by configuring it to listen on an IP address and port as wel as the Unix socket. -> **Warning** +> [!WARNING] > > Configuring Docker to accept connections from remote clients can leave you > vulnerable to unauthorized access to the host and other attacks. @@ -26,7 +26,6 @@ as the Unix socket. > Remote access without TLS is **not recommended**, and will require explicit opt-in in a future release. > For more information on how to use TLS certificates to secure this connection, see > [Protect the Docker daemon socket](../../engine/security/protect-access.md). -{ .warning } ## Enable remote access diff --git a/content/engine/daemon/troubleshoot.md b/content/engine/daemon/troubleshoot.md index 2d822c889c..7b68c88fb0 100644 --- a/content/engine/daemon/troubleshoot.md +++ b/content/engine/daemon/troubleshoot.md @@ -90,7 +90,7 @@ If you see an error similar to this one and you are starting the daemon manually with flags, you may need to adjust your flags or the `daemon.json` to remove the conflict. -> **Note** +> [!NOTE] > > If you see this specific error message about `hosts`, continue to the > [next section](#configure-the-daemon-host-with-systemd) @@ -122,7 +122,7 @@ ExecStart=/usr/bin/dockerd There are other times when you might need to configure `systemd` with Docker, such as [configuring a HTTP or HTTPS proxy](./proxy.md). -> **Note** +> [!NOTE] > > If you override this option without specifying a `hosts` entry in the > `daemon.json` or a `-H` flag when starting Docker manually, Docker fails to @@ -132,11 +132,10 @@ Run `sudo systemctl daemon-reload` before attempting to start Docker. If Docker starts successfully, it's now listening on the IP address specified in the `hosts` key of the `daemon.json` instead of a socket. -> **Important** +> [!IMPORTANT] > > Setting `hosts` in the `daemon.json` isn't supported on Docker > Desktop for Windows or Docker Desktop for Mac. -{ .important } ### Out of memory issues diff --git a/content/engine/install/_index.md b/content/engine/install/_index.md index 47f0716bc8..d6c102badb 100644 --- a/content/engine/install/_index.md +++ b/content/engine/install/_index.md @@ -56,7 +56,7 @@ through Docker Desktop. For instructions on how to install Docker Desktop, see: ### Other Linux distros -> **Note** +> [!NOTE] > > While the following instructions may work, Docker doesn't test or verify > installation on distro derivatives. diff --git a/content/engine/install/binaries.md b/content/engine/install/binaries.md index 534506b602..f6bee97d45 100644 --- a/content/engine/install/binaries.md +++ b/content/engine/install/binaries.md @@ -9,7 +9,7 @@ aliases: - /installation/binaries/ --- -> **Important** +> [!IMPORTANT] > > This page contains information on how to install Docker using binaries. These > instructions are mostly suitable for testing purposes. We do not recommend @@ -29,7 +29,6 @@ aliases: > On Windows and Mac, we recommend that you install [Docker Desktop](../../desktop/index.md) > instead. For Linux, we recommend that you follow the instructions specific for > your distribution. -{ .important } If you want to try Docker or use it in a testing environment, but you're not on a supported platform, you can try installing from static binaries. If possible, @@ -84,7 +83,6 @@ instructions for enabling and configuring AppArmor or SELinux. > If either of the security mechanisms is enabled, do not disable it as a > work-around to make Docker or its containers run. Instead, configure it > correctly to fix any problems. -{ .warning } ##### Docker daemon considerations @@ -142,7 +140,7 @@ You have now successfully installed and started Docker Engine. ## Install client binaries on macOS -> **Note** +> [!NOTE] > > The following instructions are mostly suitable for testing purposes. The macOS > binary includes the Docker client only. It does not include the `dockerd` daemon @@ -201,7 +199,7 @@ To install client binaries, perform the following steps: ## Install server and client binaries on Windows -> **Note** +> [!NOTE] > > The following section describes how to install the Docker daemon on Windows > Server which allows you to run Windows containers only. When you install the diff --git a/content/engine/install/debian.md b/content/engine/install/debian.md index 9b293a0f4e..e3264847ef 100644 --- a/content/engine/install/debian.md +++ b/content/engine/install/debian.md @@ -20,11 +20,10 @@ To get started with Docker Engine on Debian, make sure you ### Firewall limitations -> **Warning** +> [!WARNING] > > Before you install Docker, make sure you consider the following > security implications and firewall incompatibilities. -{ .warning } - If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your @@ -120,7 +119,7 @@ Docker from the repository. sudo apt-get update ``` - > **Note** + > [!NOTE] > > If you use a derivative distro, such as Kali Linux, > you may need to substitute the part of this command that's expected to diff --git a/content/engine/install/linux-postinstall.md b/content/engine/install/linux-postinstall.md index b337579a88..cfb413586e 100644 --- a/content/engine/install/linux-postinstall.md +++ b/content/engine/install/linux-postinstall.md @@ -28,14 +28,13 @@ Docker Engine using a package manager. In that case, there is no need for you to manually create the group. -> **Warning** +> [!WARNING] > > The `docker` group grants root-level privileges to the user. For > details on how this impacts security in your system, see > [Docker Daemon Attack Surface](../security/index.md#docker-daemon-attack-surface). -{ .warning } -> **Note** +> [!NOTE] > > To run Docker without root privileges, see > [Run the Docker daemon as a non-root user (Rootless mode)](../security/rootless.md). diff --git a/content/engine/install/raspberry-pi-os.md b/content/engine/install/raspberry-pi-os.md index 581b725729..68f8e22451 100644 --- a/content/engine/install/raspberry-pi-os.md +++ b/content/engine/install/raspberry-pi-os.md @@ -15,22 +15,20 @@ To get started with Docker Engine on Raspberry Pi OS, make sure you [meet the prerequisites](#prerequisites), and then follow the [installation steps](#installation-methods). -> **Important** +> [!IMPORTANT] > > This installation instruction refers to the 32-bit (armhf) version of > Raspberry Pi OS. If you're using the 64-bit (arm64) version, follow the > instructions for [Debian](debian.md). -{ .important } ## Prerequisites ### Firewall limitations -> **Warning** +> [!WARNING] > > Before you install Docker, make sure you consider the following > security implications and firewall incompatibilities. -{ .warning } - If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your diff --git a/content/engine/install/sles.md b/content/engine/install/sles.md index b0fb599f0d..2d3a237793 100644 --- a/content/engine/install/sles.md +++ b/content/engine/install/sles.md @@ -24,12 +24,11 @@ aliases: download-url-base: https://download.docker.com/linux/sles --- -> **Note** +> [!NOTE] > > The installation instructions on this page refer to packages for SLES on the > **s390x** architecture (IBM Z). Other architectures, including x86_64, aren't > supported for SLES. -{ .warning } To get started with Docker Engine on SLES, make sure you [meet the prerequisites](#prerequisites), and then follow the diff --git a/content/engine/install/ubuntu.md b/content/engine/install/ubuntu.md index a510035378..d0d6351527 100644 --- a/content/engine/install/ubuntu.md +++ b/content/engine/install/ubuntu.md @@ -28,11 +28,10 @@ To get started with Docker Engine on Ubuntu, make sure you ### Firewall limitations -> **Warning** +> [!WARNING] > > Before you install Docker, make sure you consider the following > security implications and firewall incompatibilities. -{ .warning } - If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your @@ -130,7 +129,7 @@ Docker from the repository. sudo apt-get update ``` - > **Note** + > [!NOTE] > > If you use an Ubuntu derivative distro, such as Linux Mint, > you may need to use `UBUNTU_CODENAME` instead of `VERSION_CODENAME`. diff --git a/content/engine/logging/configure.md b/content/engine/logging/configure.md index f2f0510a70..0febf718be 100644 --- a/content/engine/logging/configure.md +++ b/content/engine/logging/configure.md @@ -39,7 +39,6 @@ included with Docker, you can also implement and use [logging driver plugins](pl > section below to learn how to configure the `local` logging driver as a default, > and the [local file logging driver](drivers/local.md) page for more details about the > `local` logging driver. -{ .tip } ## Configure the default logging driver @@ -77,7 +76,7 @@ example sets four configurable options on the `json-file` logging driver: Restart Docker for the changes to take effect for newly created containers. Existing containers don't use the new logging configuration automatically. -> **Note** +> [!NOTE] > > `log-opts` configuration options in the `daemon.json` configuration file must > be provided as strings. Boolean and numeric values (such as the value for @@ -94,7 +93,7 @@ $ docker info --format '{{.LoggingDriver}}' json-file ``` -> **Note** +> [!NOTE] > > Changing the default logging driver or logging driver options in the daemon > configuration only affects containers that are created after the configuration @@ -141,11 +140,10 @@ The `non-blocking` message delivery mode prevents applications from blocking due to logging back pressure. Applications are likely to fail in unexpected ways when STDERR or STDOUT streams block. -> **Warning** +> [!WARNING] > > When the buffer is full, new messages will not be enqueued. Dropping messages is often preferred to blocking the > log-writing process of an application. -{ .warning } The `mode` log option controls whether to use the `blocking` (default) or `non-blocking` message delivery. diff --git a/content/engine/logging/drivers/awslogs.md b/content/engine/logging/drivers/awslogs.md index 9892e823cc..35751ffa2d 100644 --- a/content/engine/logging/drivers/awslogs.md +++ b/content/engine/logging/drivers/awslogs.md @@ -77,7 +77,7 @@ detected region to construct the remote CloudWatch Logs API endpoint. Use the `awslogs-endpoint` log option to override the default endpoint with the provided endpoint. -> **Note** +> [!NOTE] > > The `awslogs-region` log option or detected region controls the > region used for signing. You may experience signature errors if the @@ -101,7 +101,7 @@ To configure which should be used, you can specify the `awslogs-stream` log option. If not specified, the container ID is used as the log stream. -> **Note** +> [!NOTE] > > Log streams within a given log group should only be used by one container > at a time. Using the same log stream for multiple containers concurrently @@ -122,7 +122,7 @@ $ docker run \ ... ``` -> **Note** +> [!NOTE] > > Your AWS IAM policy must include the `logs:CreateLogGroup` permission before > you attempt to use `awslogs-create-group`. @@ -142,7 +142,7 @@ single entry. This option always takes precedence if both `awslogs-datetime-format` and `awslogs-multiline-pattern` are configured. -> **Note** +> [!NOTE] > > Multi-line logging performs regular expression parsing and matching of all log > messages, which may have a negative impact on logging performance. @@ -219,7 +219,7 @@ the delimiter between log messages. This option is ignored if `awslogs-datetime-format` is also configured. -> **Note** +> [!NOTE] > > Multi-line logging performs regular expression parsing and matching of all log > messages. This may have a negative impact on logging performance. @@ -272,7 +272,7 @@ When both `awslogs-stream` and `tag` are specified, the value supplied for If not specified, the container ID is used as the log stream. -> **Note** +> [!NOTE] > > The CloudWatch log API doesn't support `:` in the log name. This can cause > some issues when using the `{{ .ImageName }}` as a tag, diff --git a/content/engine/logging/drivers/etwlogs.md b/content/engine/logging/drivers/etwlogs.md index e984ca2424..34a579973e 100644 --- a/content/engine/logging/drivers/etwlogs.md +++ b/content/engine/logging/drivers/etwlogs.md @@ -63,7 +63,7 @@ log: Hello world! A client can parse this message string to get both the log message, as well as its context information. The timestamp is also available within the ETW event. -> **Note** +> [!NOTE] > > This ETW provider only emits a message string, and not a specially structured > ETW event. Therefore, you don't have to register a manifest file with the diff --git a/content/engine/logging/drivers/fluentd.md b/content/engine/logging/drivers/fluentd.md index 10e4f80053..5e65ca25ce 100644 --- a/content/engine/logging/drivers/fluentd.md +++ b/content/engine/logging/drivers/fluentd.md @@ -52,7 +52,7 @@ The following example sets the log driver to `fluentd` and sets the Restart Docker for the changes to take effect. -> **Note** +> [!NOTE] > > `log-opts` configuration options in the `daemon.json` configuration file must > be provided as strings. Boolean and numeric values (such as the value for diff --git a/content/engine/logging/drivers/gelf.md b/content/engine/logging/drivers/gelf.md index b45d34e911..f5eec31be1 100644 --- a/content/engine/logging/drivers/gelf.md +++ b/content/engine/logging/drivers/gelf.md @@ -42,7 +42,7 @@ option. Restart Docker for the changes to take effect. -> **Note** +> [!NOTE] > > `log-opts` configuration options in the `daemon.json` configuration file must > be provided as strings. Boolean and numeric values (such as the value for @@ -74,7 +74,7 @@ The `gelf` logging driver supports the following options: | `env` | optional | Applies when starting the Docker daemon. A comma-separated list of logging-related environment variables this daemon accepts. Adds additional key on the `extra` fields, prefixed by an underscore (`_`). Used for advanced [log tag options](log_tags.md). | `--log-opt env=os,customer` | | `env-regex` | optional | Similar to and compatible with `env`. A regular expression to match logging-related environment variables. Used for advanced [log tag options](log_tags.md). | `--log-opt env-regex=^(os\|customer)` | -> **Note** +> [!NOTE] > > The `gelf` driver doesn't support TLS for TCP connections. Messages sent to TLS-protected inputs can silently fail. diff --git a/content/engine/logging/drivers/json-file.md b/content/engine/logging/drivers/json-file.md index de4551bfdf..089a37656d 100644 --- a/content/engine/logging/drivers/json-file.md +++ b/content/engine/logging/drivers/json-file.md @@ -21,13 +21,12 @@ only one container. } ``` -> **Warning** +> [!WARNING] > > The `json-file` logging driver uses file-based storage. These files are designed > to be exclusively accessed by the Docker daemon. Interacting with these files > with external tools may interfere with Docker's logging system and result in > unexpected behavior, and should be avoided. -{ .warning } ## Usage @@ -51,7 +50,7 @@ and `max-file` options to enable automatic log-rotation. } ``` -> **Note** +> [!NOTE] > > `log-opts` configuration options in the `daemon.json` configuration file must > be provided as strings. Boolean and numeric values (such as the value for diff --git a/content/engine/logging/drivers/local.md b/content/engine/logging/drivers/local.md index 53008a7f52..a3a86b22e7 100644 --- a/content/engine/logging/drivers/local.md +++ b/content/engine/logging/drivers/local.md @@ -16,13 +16,12 @@ By default, the `local` driver preserves 100MB of log messages per container and uses automatic compression to reduce the size on disk. The 100MB default value is based on a 20M default size for each file and a default count of 5 for the number of such files (to account for log rotation). -> **Warning** +> [!WARNING] > > The `local` logging driver uses file-based storage. These files are designed > to be exclusively accessed by the Docker daemon. Interacting with these files > with external tools may interfere with Docker's logging system and result in > unexpected behavior, and should be avoided. -{ .warning } ## Usage diff --git a/content/engine/logging/drivers/splunk.md b/content/engine/logging/drivers/splunk.md index 3f29b0064f..c9e1e7e766 100644 --- a/content/engine/logging/drivers/splunk.md +++ b/content/engine/logging/drivers/splunk.md @@ -37,7 +37,7 @@ The daemon.json file is located in `/etc/docker/` on Linux hosts or configuring Docker using `daemon.json`, see [daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). -> **Note** +> [!NOTE] > > `log-opts` configuration options in the `daemon.json` configuration file must > be provided as strings. Boolean and numeric values (such as the value for diff --git a/content/engine/logging/drivers/syslog.md b/content/engine/logging/drivers/syslog.md index 3ce24b94c6..803ca29b4e 100644 --- a/content/engine/logging/drivers/syslog.md +++ b/content/engine/logging/drivers/syslog.md @@ -56,7 +56,7 @@ this example uses UDP. Restart Docker for the changes to take effect. -> **Note** +> [!NOTE] > > `log-opts` configuration options in the `daemon.json` configuration file must > be provided as strings. Numeric and Boolean values (such as the value for diff --git a/content/engine/logging/dual-logging.md b/content/engine/logging/dual-logging.md index 28ce37a294..15a1887f2a 100644 --- a/content/engine/logging/dual-logging.md +++ b/content/engine/logging/dual-logging.md @@ -101,7 +101,7 @@ as a default, with dual logging caching enabled: 2019-02-04T19:48:15.599Z [INFO] core: cluster listeners successfully shut down ``` -> **Note** +> [!NOTE] > > For logging drivers that support reading logs, such as the `local`, `json-file` > and `journald` drivers, there is no difference in functionality before or after @@ -150,7 +150,7 @@ $ cat /etc/docker/daemon.json } ``` -> **Note** +> [!NOTE] > > For logging drivers that support reading logs, such as the `local`, `json-file` > and `journald` drivers, dual logging isn't used, and disabling the option has diff --git a/content/engine/network/_index.md b/content/engine/network/_index.md index 5968fb7493..487947d59f 100644 --- a/content/engine/network/_index.md +++ b/content/engine/network/_index.md @@ -106,7 +106,7 @@ Here are some examples: | `-p 8080:80/udp` | Map port `8080` on the Docker host to UDP port `80` in the container. | | `-p 8080:80/tcp -p 8080:80/udp` | Map TCP port `8080` on the Docker host to TCP port `80` in the container, and map UDP port `8080` on the Docker host to UDP port `80` in the container. | -> **Important** +> [!IMPORTANT] > > Publishing container ports is insecure by default. Meaning, when you publish > a container's ports it becomes available not only to the Docker host, but to @@ -120,14 +120,12 @@ Here are some examples: > $ docker run -p 127.0.0.1:8080:80 -p '[::1]:8080:80' nginx > ``` > -> > **Warning** +> > [!WARNING] > > > > Hosts within the same L2 segment (for example, hosts connected to the same > > network switch) can reach ports published to localhost. > > For more information, see > > [moby/moby#45610](https://github.com/moby/moby/issues/45610) -> { .warning } -{ .important } If you want to make a container accessible to other containers, it isn't necessary to publish the container's ports. diff --git a/content/engine/network/drivers/host.md b/content/engine/network/drivers/host.md index 2541f0aa05..077bc125fb 100644 --- a/content/engine/network/drivers/host.md +++ b/content/engine/network/drivers/host.md @@ -14,7 +14,7 @@ For instance, if you run a container which binds to port 80 and you use `host` networking, the container's application is available on port 80 on the host's IP address. -> **Note** +> [!NOTE] > > Given that the container does not have its own IP-address when using > `host` mode networking, [port-mapping](overlay.md#publish-ports) doesn't diff --git a/content/engine/network/drivers/ipvlan.md b/content/engine/network/drivers/ipvlan.md index 673c5b7347..ac604ba972 100644 --- a/content/engine/network/drivers/ipvlan.md +++ b/content/engine/network/drivers/ipvlan.md @@ -372,7 +372,7 @@ $ docker run --net=ipnet210 --ip=10.1.214.9 -it --rm alpine ping -c 2 192.168.21 ``` -> **Note** +> [!NOTE] > > Notice that there is no `--gateway=` option in the network create. The field > is ignored if one is specified `l3` mode. Take a look at the container routing @@ -504,7 +504,7 @@ using IPv4 packets: $ docker run --net=ipvlan140 --ip=192.168.140.10 -it --rm alpine /bin/sh ``` -> **Note** +> [!NOTE] > > Different subnets on the same parent interface in IPvlan `L2` mode cannot ping > one another. That requires a router to proxy-arp the requests with a secondary @@ -573,7 +573,7 @@ $$ ip -6 route default dev eth0 metric 1024 ``` -> **Note** +> [!NOTE] > > There may be a bug when specifying `--ip6=` addresses when you delete a > container with a specified v6 address and then start a new container with the diff --git a/content/engine/network/drivers/overlay.md b/content/engine/network/drivers/overlay.md index f65c1a9a82..ccbaeef540 100644 --- a/content/engine/network/drivers/overlay.md +++ b/content/engine/network/drivers/overlay.md @@ -71,7 +71,7 @@ This enables IPsec encryption at the level of the Virtual Extensible LAN (VXLAN) This encryption imposes a non-negligible performance penalty, so you should test this option before using it in production. -> **Warning** +> [!WARNING] > > Don't attach Windows containers to encrypted overlay networks. > @@ -82,7 +82,6 @@ so you should test this option before using it in production. > > - Windows containers can't communicate with Linux containers on the network > - Data traffic between Windows containers on the network isn't encrypted -{ .warning } ## Attach a container to an overlay network @@ -96,7 +95,7 @@ To join an overlay network named `multi-host-network` with a `busybox` container $ docker run --network multi-host-network busybox sh ``` -> **Note** +> [!NOTE] > > This only works if the overlay network is attachable > (created with the `--attachable` flag). diff --git a/content/engine/network/links.md b/content/engine/network/links.md index 58c39acbf9..99eb5a87ab 100644 --- a/content/engine/network/links.md +++ b/content/engine/network/links.md @@ -21,7 +21,6 @@ between containers in a more controlled way. > > See [Differences between user-defined bridges and the default bridge](drivers/bridge.md#differences-between-user-defined-bridges-and-the-default-bridge) > for some alternatives to using `--link`. -{ .warning } The information in this section explains legacy container links within the Docker default `bridge` network which is created automatically when you install @@ -45,7 +44,7 @@ Let's say you used this command to run a simple Python Flask application: $ docker run -d -P training/webapp python app.py ``` -> **Note** +> [!NOTE] > > Containers have an internal network and an IP address. > Docker can have a variety of network configurations. You can see more @@ -120,13 +119,13 @@ $ docker port nostalgic_morse 5000 127.0.0.1:49155 ``` -> **Note** +> [!NOTE] > > The `-p` flag can be used multiple times to configure multiple ports. ## Connect with the linking system -> **Note** +> [!NOTE] > > This section covers the legacy link feature in the default `bridge` network. > Refer to [differences between user-defined bridges and the default bridge](drivers/bridge.md#differences-between-user-defined-bridges-and-the-default-bridge) @@ -174,7 +173,7 @@ aed84ee21bde training/webapp:latest python app.py 12 hours ago Up 2 seconds 0 You can also use `docker inspect` to return the container's name. -> **Note** +> [!NOTE] > > Container names must be unique. That means you can only call > one container `web`. If you want to re-use a container name you must delete @@ -271,13 +270,12 @@ command when the source container is started These environment variables enable programmatic discovery from within the target container of information related to the source container. -> **Warning** +> [!WARNING] > > It is important to understand that all environment variables originating > from Docker within a container are made available to any container > that links to it. This could have serious security implications if sensitive > data is stored in them. -{ .warning } Docker sets an `_NAME` environment variable for each target container listed in the `--link` parameter. For example, if a new container called @@ -387,7 +385,7 @@ PING webdb (172.17.0.5): 48 data bytes 56 bytes from 172.17.0.5: icmp_seq=2 ttl=64 time=0.256 ms ``` -> **Note** +> [!NOTE] > > In the example, you had to install `ping` because it was not included > in the container initially. @@ -396,7 +394,7 @@ Here, you used the `ping` command to ping the `db` container using its host entr which resolves to `172.17.0.5`. You can use this host entry to configure an application to make use of your `db` container. -> **Note** +> [!NOTE] > > You can link multiple recipient containers to a single source. For > example, you could have multiple (differently named) web containers attached to your diff --git a/content/engine/network/packet-filtering-firewalls.md b/content/engine/network/packet-filtering-firewalls.md index 2df8205d9b..63bcbc4071 100644 --- a/content/engine/network/packet-filtering-firewalls.md +++ b/content/engine/network/packet-filtering-firewalls.md @@ -18,7 +18,7 @@ probably want to add iptables policies that prevent unauthorized access to containers or other services running on your host. This page describes how to achieve that, and the caveats you need to be aware of. -> **Note** +> [!NOTE] > > Docker creates `iptables` rules for bridge networks. > @@ -69,10 +69,9 @@ $ sudo iptables -I DOCKER-USER -p tcp -m conntrack --ctstate ESTABLISHED,RELATED $ sudo iptables -I DOCKER-USER -p tcp -m conntrack --ctorigdst 198.51.100.2 --ctorigdstport 80 -j ACCEPT ``` -> **Important** +> [!IMPORTANT] > > Using the `conntrack` extension may result in degraded performance. -{ .important } ## Port publishing and mapping @@ -212,13 +211,12 @@ You can change the default binding address for published container ports so that they're only accessible to the Docker host by default. To do that, you can configure the daemon to use the loopback address (`127.0.0.1`) instead. -> **Warning** +> [!WARNING] > > Hosts within the same L2 segment (for example, hosts connected to the same > network switch) can reach ports published to localhost. > For more information, see > [moby/moby#45610](https://github.com/moby/moby/issues/45610) -{ .warning } To configure this setting for user-defined bridge networks, use the `com.docker.network.bridge.host_binding_ipv4` @@ -229,7 +227,7 @@ $ docker network create mybridge \ -o "com.docker.network.bridge.host_binding_ipv4=127.0.0.1" ``` -> **Note** +> [!NOTE] > > - Setting the default binding address to `::` means port bindings with no host > address specified will work for any IPv6 address on the host. But, `0.0.0.0` diff --git a/content/engine/network/tutorials/overlay.md b/content/engine/network/tutorials/overlay.md index 420ec38ae7..1a4bed7b88 100644 --- a/content/engine/network/tutorials/overlay.md +++ b/content/engine/network/tutorials/overlay.md @@ -165,7 +165,7 @@ connect a service to each of them. service will publish port 80 to the outside world. All of the service task containers can communicate with each other without opening any ports. - > **Note** + > [!NOTE] > > Services can only be created on a manager. @@ -221,7 +221,7 @@ connect a service to each of them. `nginx-net-2` and notice that all the service task containers are connected to it. - > **Note** + > [!NOTE] > > Even though overlay networks are automatically created on swarm > worker nodes as needed, they are not automatically removed. @@ -370,7 +370,7 @@ example also uses Linux hosts, but the same commands work on Windows. fb635f5ece59563e7b8b99556f816d24e6949a5f6a5b1fbd92ca244db17a4342 ``` - > **Note** + > [!NOTE] > > Automatic DNS container discovery only works with unique container names. diff --git a/content/engine/network/tutorials/standalone.md b/content/engine/network/tutorials/standalone.md index 3ca32146b0..c9eeb3cdb9 100644 --- a/content/engine/network/tutorials/standalone.md +++ b/content/engine/network/tutorials/standalone.md @@ -439,7 +439,7 @@ connected to both networks. connect to `alpine1` and test this out. `alpine1` should be able to resolve `alpine2` and `alpine4` (and `alpine1`, itself) to IP addresses. - > **Note** + > [!NOTE] > > Automatic service discovery can only resolve custom container names, not default automatically generated container names, diff --git a/content/engine/release-notes/17.06.md b/content/engine/release-notes/17.06.md index 0f2593a261..ca501be9e4 100644 --- a/content/engine/release-notes/17.06.md +++ b/content/engine/release-notes/17.06.md @@ -79,14 +79,14 @@ toc_max: 2 ## 17.06.0-ce 2017-06-28 -> **Note**: Docker 17.06.0 has an issue in the image builder causing a change in the behavior +> [!NOTE]: Docker 17.06.0 has an issue in the image builder causing a change in the behavior > of the `ADD` instruction of Dockerfile when referencing a remote `.tar.gz` file. The issue will be > fixed in Docker 17.06.1. -> **Note**: Starting with Docker CE 17.06, Ubuntu packages are also available +> [!NOTE]: Starting with Docker CE 17.06, Ubuntu packages are also available > for IBM Z using the s390x architecture. -> **Note**: Docker 17.06 by default disables communication with legacy (v1) +> [!NOTE]: Docker 17.06 by default disables communication with legacy (v1) > registries. If you require interaction with registries that have not yet > migrated to the v2 protocol, set the `--disable-legacy-registry=false` daemon > option. Interaction with v1 registries will be removed in Docker 17.12. diff --git a/content/engine/release-notes/17.10.md b/content/engine/release-notes/17.10.md index d846967562..16200165dd 100644 --- a/content/engine/release-notes/17.10.md +++ b/content/engine/release-notes/17.10.md @@ -7,10 +7,9 @@ toc_max: 2 ## 17.10.0-ce 2017-10-17 -> **Important**: Starting with this release, `docker service create`, `docker service update`, +> [!IMPORTANT]: Starting with this release, `docker service create`, `docker service update`, `docker service scale` and `docker service rollback` use non-detached mode as default, use `--detach` to keep the old behaviour. -{ .important } ### Builder diff --git a/content/engine/release-notes/17.11.md b/content/engine/release-notes/17.11.md index b3481ef64b..9248dc5359 100644 --- a/content/engine/release-notes/17.11.md +++ b/content/engine/release-notes/17.11.md @@ -7,7 +7,7 @@ toc_max: 2 ## 17.11.0-ce 2017-11-20 -> **Important**: Docker CE 17.11 is the first Docker release based on +> [!IMPORTANT]: Docker CE 17.11 is the first Docker release based on [containerd 1.0 beta](https://github.com/containerd/containerd/releases/tag/v1.0.0-beta.2). Docker CE 17.11 and later don't recognize containers started with previous Docker versions. If using @@ -16,7 +16,6 @@ you must stop all containers before upgrading to Docker CE 17.11. If you don't, any containers started by Docker versions that predate 17.11 aren't recognized by Docker after the upgrade and keep running, un-managed, on the system. -{ .important } ### Builder diff --git a/content/engine/release-notes/20.10.md b/content/engine/release-notes/20.10.md index 9630e860d2..7895aad5e3 100644 --- a/content/engine/release-notes/20.10.md +++ b/content/engine/release-notes/20.10.md @@ -353,7 +353,7 @@ before v0.11.0 are not able to detect the [Log4j 2 CVE-2021-44228](https://nvd.n We are shipping an updated version of `docker scan` in this release to help you scan your images for this vulnerability. -> **Note** +> [!NOTE] > > The `docker scan` command on Linux is currently only supported on x86 platforms. > We do not yet provide a package for other hardware architectures on Linux. @@ -407,7 +407,6 @@ to learn how to use the `docker scan` command to check if images are vulnerable. > > Refer to [Configure the daemon to use a proxy](/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. -{ .important } ### Distribution @@ -437,7 +436,6 @@ to learn how to use the `docker scan` command to check if images are vulnerable. > > Refer to the [HTTP/HTTPS proxy section](/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. -{ .important } ### Builder @@ -478,7 +476,6 @@ well as updated versions of the containerd.io package. > > Refer to the [HTTP/HTTPS proxy section](/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. -{ .important } ### Client @@ -523,7 +520,6 @@ well as updated versions of the containerd.io package. > > Refer to the [HTTP/HTTPS proxy section](/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. -{ .important } ### Deprecation diff --git a/content/engine/release-notes/23.0.md b/content/engine/release-notes/23.0.md index b89f35ab75..5570393a72 100644 --- a/content/engine/release-notes/23.0.md +++ b/content/engine/release-notes/23.0.md @@ -7,7 +7,7 @@ toc_min: 1 toc_max: 2 --- -> **Note** +> [!NOTE] > > From Docker Engine version 23.0.0, Buildx is distributed in a separate package: `docker-buildx-plugin`. > In earlier versions, Buildx was included in the `docker-ce-cli` package. @@ -110,7 +110,7 @@ For a full list of pull requests and changes in this release, refer to the relev {{< release-date date="2023-04-04" >}} -> **Note** +> [!NOTE] > > Due to an issue with CentOS 9 Stream's package repositories, packages for > CentOS 9 are currently unavailable. Packages for CentOS 9 may be added later, diff --git a/content/engine/release-notes/24.0.md b/content/engine/release-notes/24.0.md index d2beb03d87..32a2b04287 100644 --- a/content/engine/release-notes/24.0.md +++ b/content/engine/release-notes/24.0.md @@ -33,7 +33,7 @@ affecting Docker Engine and its components. | [CVE-2024-21626](https://scout.docker.com/v/CVE-2024-21626) | runc | 1.1.12 | High, CVSS 8.6 | | [CVE-2024-24557](https://scout.docker.com/v/CVE-2024-24557) | Docker Engine | 24.0.9 | Medium, CVSS 6.9 | -> **Important** +> [!IMPORTANT] > > Note that this release of Docker Engine doesn't include fixes for > the following known vulnerabilities in BuildKit: @@ -45,7 +45,6 @@ affecting Docker Engine and its components. > > To address these vulnerabilities, > upgrade to [Docker Engine v25.0.2](./25.0.md#2502). -{ .important } For more information about the security issues addressed in this release, and the unaddressed vulnerabilities in BuildKit, diff --git a/content/engine/release-notes/25.0.md b/content/engine/release-notes/25.0.md index 33ceb82a20..9c33e42c73 100644 --- a/content/engine/release-notes/25.0.md +++ b/content/engine/release-notes/25.0.md @@ -80,7 +80,7 @@ For a full list of pull requests and changes in this release, refer to the relev - containerd image store: Fix a bug where `docker image history` would fail if a manifest wasn't found in the content store. [moby/moby#47348](https://github.com/moby/moby/pull/47348) - Ensure that a generated MAC address is not restored when a container is restarted, but a configured MAC address is preserved. [moby/moby#47304](https://github.com/moby/moby/pull/47304) - > **Note** + > [!NOTE] > > - Containers created with Docker Engine version 25.0.0 may have duplicate MAC addresses. > They must be re-created. @@ -185,7 +185,7 @@ For a full list of pull requests and changes in this release, refer to the relev - [docker/cli, 25.0.0 milestone](https://github.com/docker/cli/issues?q=is%3Aclosed+milestone%3A25.0.0) - [moby/moby, 25.0.0 milestone](https://github.com/moby/moby/issues?q=is%3Aclosed+milestone%3A25.0.0) -> **Note** +> [!NOTE] > > In earlier versions of Docker Engine, recursive mounts (submounts) would > always be mounted as writable, even when specifying a read-only mount. This diff --git a/content/engine/release-notes/26.0.md b/content/engine/release-notes/26.0.md index 1aeef455b0..02487b551b 100644 --- a/content/engine/release-notes/26.0.md +++ b/content/engine/release-notes/26.0.md @@ -89,14 +89,14 @@ This release contains a security fix for [CVE-2024-29018], a potential data exfi - [CVE-2024-29018]: Do not forward requests to external DNS servers for a container that is only connected to an 'internal' network. Previously, requests were forwarded if the host's DNS server was running on a loopback address, like systemd's 127.0.0.53. [moby/moby#47589](https://github.com/moby/moby/pull/47589) - Ensure that a generated MAC address is not restored when a container is restarted, but a configured MAC address is preserved. [moby/moby#47233](https://github.com/moby/moby/pull/47233) - > **Warning** + > [!WARNING] > > Containers created using Docker Engine 25.0.0 may have duplicate MAC addresses, they must be re-created. > Containers created using version 25.0.0 or 25.0.1 with user-defined MAC addresses will get generated MAC addresses when they are started using 25.0.2. They must also be re-created. - Always attempt to enable IPv6 on a container's loopback interface, and only include IPv6 in `/etc/hosts` if successful. [moby/moby#47062](https://github.com/moby/moby/pull/47062) - > **Note** + > [!NOTE] > > By default, IPv6 will remain enabled on a container's loopback interface when the container is not connected to an IPv6-enabled network. > For example, containers that are only connected to an IPv4-only network now have the `::1` address on their loopback interface. diff --git a/content/engine/release-notes/26.1.md b/content/engine/release-notes/26.1.md index 8b6e027b0a..ca46e4f931 100644 --- a/content/engine/release-notes/26.1.md +++ b/content/engine/release-notes/26.1.md @@ -106,7 +106,7 @@ For a full list of pull requests and changes in this release, refer to the relev - Experimental environment variable `DOCKER_BRIDGE_PRESERVE_KERNEL_LL=1` will prevent the daemon from removing the kernel-assigned link local address on a Linux bridge. [moby/moby#47775](https://github.com/moby/moby/pull/47775) - Resolve an issue preventing container creation on hosts with a read-only `/proc/sys/net` filesystem. If IPv6 cannot be disabled on an interface due to this, either disable IPv6 by default on the host or ensure `/proc/sys/net` is read-write. To bypass the error, set the environment variable `DOCKER_ALLOW_IPV6_ON_IPV4_INTERFACE=1` before starting the Docker daemon. [moby/moby#47769](https://github.com/moby/moby/pull/47769) -> **Note** +> [!NOTE] > > The `DOCKER_ALLOW_IPV6_ON_IPV4_INTERFACE` is added as a temporary fix and will be phased out in a future major release, when the IPv6 enablement process has been improved. @@ -148,7 +148,7 @@ For a full list of pull requests and changes in this release, refer to the relev [moby/moby#47584](https://github.com/moby/moby/pull/47584) - > **Note** + > [!NOTE] > > - This will be the new default behavior in Docker Engine 27.0. > - The `windows-dns-proxy` feature flag will be removed in a future release. diff --git a/content/engine/release-notes/prior-releases.md b/content/engine/release-notes/prior-releases.md index 550b39fb2b..cdb2824135 100644 --- a/content/engine/release-notes/prior-releases.md +++ b/content/engine/release-notes/prior-releases.md @@ -3342,4 +3342,4 @@ Initial public release - Add Vagrant support with Vagrantfile - Add unit tests - Add repository/tags to ease image management -- Improve the layer implementation \ No newline at end of file +- Improve the layer implementation diff --git a/content/engine/security/antivirus.md b/content/engine/security/antivirus.md index 37bf53282b..326103fb78 100644 --- a/content/engine/security/antivirus.md +++ b/content/engine/security/antivirus.md @@ -13,4 +13,4 @@ antivirus's exclusion list. However, this comes with the trade-off that viruses or malware in Docker images, writable layers of containers, or volumes are not detected. If you do choose to exclude Docker's data directory from background virus scanning, you may want to schedule a recurring task that stops Docker, -scans the data directory, and restarts Docker. \ No newline at end of file +scans the data directory, and restarts Docker. diff --git a/content/engine/security/apparmor.md b/content/engine/security/apparmor.md index 86bd09f90a..f56bf9abad 100644 --- a/content/engine/security/apparmor.md +++ b/content/engine/security/apparmor.md @@ -13,7 +13,7 @@ Docker automatically generates and loads a default profile for containers named `docker-default`. The Docker binary generates this profile in `tmpfs` and then loads it into the kernel. -> **Note** +> [!NOTE] > > This profile is used on containers, not on the Docker daemon. diff --git a/content/engine/security/certificates.md b/content/engine/security/certificates.md index 95bf831076..1ce380c142 100644 --- a/content/engine/security/certificates.md +++ b/content/engine/security/certificates.md @@ -25,7 +25,7 @@ A custom certificate is configured by creating a directory under `/etc/docker/certs.d` using the same name as the registry's hostname, such as `localhost`. All `*.crt` files are added to this directory as CA roots. -> **Note** +> [!NOTE] > > On Linux any root certificates authorities are merged with the system defaults, > including the host's root CA set. If you are running Docker on Windows Server, @@ -36,7 +36,7 @@ The presence of one or more `.key/cert` pairs indicates to Docker that there are custom certificates required for access to the desired repository. -> **Note** +> [!NOTE] > > If multiple certificates exist, each is tried in alphabetical > order. If there is a 4xx-level or 5xx-level authentication error, Docker @@ -68,7 +68,7 @@ $ openssl genrsa -out client.key 4096 $ openssl req -new -x509 -text -key client.key -out client.cert ``` -> **Note** +> [!NOTE] > > These TLS commands only generate a working set of certificates on Linux. > The version of OpenSSL in macOS is incompatible with the type of diff --git a/content/engine/security/https/README.md b/content/engine/security/https/README.md index 85562d0835..3ba7049387 100644 --- a/content/engine/security/https/README.md +++ b/content/engine/security/https/README.md @@ -19,7 +19,7 @@ My process is as following: lots of things to see and manually answer, as openssl wants to be interactive -> **Note**: make sure you enter the hostname (`boot2docker` in my case) when prompted for `Computer Name`) +> [!NOTE]: make sure you enter the hostname (`boot2docker` in my case) when prompted for `Computer Name`) root@boot2docker:/# sudo make run diff --git a/content/engine/security/non-events.md b/content/engine/security/non-events.md index ce0c705ca3..dd2a1d809b 100644 --- a/content/engine/security/non-events.md +++ b/content/engine/security/non-events.md @@ -89,4 +89,4 @@ handled the copy-on-write (COW) breakage of private read-only memory mappings, which allowed unprivileged local users to gain write access to read-only memory. Also known as "dirty COW." *Partial mitigations:* on some operating systems this vulnerability is mitigated -by the combination of seccomp filtering of `ptrace` and the fact that `/proc/self/mem` is read-only. \ No newline at end of file +by the combination of seccomp filtering of `ptrace` and the fact that `/proc/self/mem` is read-only. diff --git a/content/engine/security/protect-access.md b/content/engine/security/protect-access.md index ac7844f8b2..410abec42c 100644 --- a/content/engine/security/protect-access.md +++ b/content/engine/security/protect-access.md @@ -13,7 +13,7 @@ optionally communicate using SSH or a TLS (HTTPS) socket. ## Use SSH to protect the Docker daemon socket -> **Note** +> [!NOTE] > > The given `USERNAME` must have permissions to access the docker socket on the > remote machine. Refer to [manage Docker as a non-root user](../install/linux-postinstall.md#manage-docker-as-a-non-root-user) @@ -85,15 +85,14 @@ In the daemon mode, it only allows connections from clients authenticated by a certificate signed by that CA. In the client mode, it only connects to servers with a certificate signed by that CA. -> **Important** +> [!IMPORTANT] > > Using TLS and managing a CA is an advanced topic. Familiarize yourself > with OpenSSL, x509, and TLS before using it in production. -{ .important } ### Create a CA, server and client keys with OpenSSL -> **Note** +> [!NOTE] > > Replace all instances of `$HOST` in the following example with the > DNS name of your Docker daemon's host. @@ -131,7 +130,7 @@ Now that you have a CA, you can create a server key and certificate signing request (CSR). Make sure that "Common Name" matches the hostname you use to connect to Docker: -> **Note** +> [!NOTE] > > Replace all instances of `$HOST` in the following example with the > DNS name of your Docker daemon's host. @@ -183,7 +182,7 @@ Docker clients. For client authentication, create a client key and certificate signing request: -> **Note** +> [!NOTE] > > For simplicity of the next couple of steps, you may perform this > step on the Docker daemon's host machine as well. @@ -255,14 +254,13 @@ $ dockerd \ To connect to Docker and validate its certificate, provide your client keys, certificates and trusted CA: -> **Tip** +> [!TIP] > > This step should be run on your Docker client machine. As such, you > need to copy your CA certificate, your server certificate, and your client > certificate to that machine. -{ .tip } -> **Note** +> [!NOTE] > > Replace all instances of `$HOST` in the following example with the > DNS name of your Docker daemon's host. @@ -275,18 +273,17 @@ $ docker --tlsverify \ -H=$HOST:2376 version ``` -> **Note** +> [!NOTE] > > Docker over TLS should run on TCP port 2376. -> **Warning** +> [!WARNING] > > As shown in the example above, you don't need to run the `docker` client > with `sudo` or the `docker` group when you use certificate authentication. > That means anyone with the keys can give any instructions to your Docker > daemon, giving them root access to the machine hosting the daemon. Guard > these keys as you would a root password! -{ .warning } ### Secure by default diff --git a/content/engine/security/rootless.md b/content/engine/security/rootless.md index 8ac10779b8..738996e67d 100644 --- a/content/engine/security/rootless.md +++ b/content/engine/security/rootless.md @@ -45,10 +45,9 @@ testuser:231072:65536 ### Distribution-specific hint -> **Tip** +> [!TIP] > > We recommend that you use the Ubuntu kernel. -{ .tip } {{< tabs >}} {{< tab name="Ubuntu" >}} @@ -157,7 +156,7 @@ testuser:231072:65536 ## Install -> **Note** +> [!NOTE] > > If the system-wide Docker daemon is already running, consider disabling it: >```console @@ -405,7 +404,7 @@ EOF # systemctl daemon-reload ``` -> **Note** +> [!NOTE] > > Delegating `cpuset` requires systemd 244 or later. @@ -484,7 +483,7 @@ $ mkdir -p $XDG_RUNTIME_DIR $ dockerd-rootless.sh ``` -> **Note** +> [!NOTE] > > You must remove the directory every time you log out. diff --git a/content/engine/security/trust/_index.md b/content/engine/security/trust/_index.md index 992790d592..8ac5f3f219 100644 --- a/content/engine/security/trust/_index.md +++ b/content/engine/security/trust/_index.md @@ -95,11 +95,10 @@ The following image depicts the various signing keys and their relationships: ![Content Trust components](images/trust_components.png) -> **Warning** +> [!WARNING] > >The root key once lost is not recoverable. If you lose any other key, send an email to [Docker Hub Support](mailto:hub-support@docker.com). This loss also requires manual intervention from every consumer that used a signed tag from this repository prior to the loss. -{ .warning } You should back up the root key somewhere safe. Given that it is only required to create new repositories, it is a good idea to store it offline in hardware. diff --git a/content/engine/security/trust/trust_automation.md b/content/engine/security/trust/trust_automation.md index 29d0a75a9c..6a972f9fca 100644 --- a/content/engine/security/trust/trust_automation.md +++ b/content/engine/security/trust/trust_automation.md @@ -106,4 +106,4 @@ unable to process Dockerfile: No trust data for notrust * [Delegations for content trust](trust_delegation.md) * [Content trust in Docker](index.md) * [Manage keys for content trust](trust_key_mng.md) -* [Play in a content trust sandbox](trust_sandbox.md) \ No newline at end of file +* [Play in a content trust sandbox](trust_sandbox.md) diff --git a/content/engine/security/trust/trust_delegation.md b/content/engine/security/trust/trust_delegation.md index 196ef5db90..1c0d250120 100644 --- a/content/engine/security/trust/trust_delegation.md +++ b/content/engine/security/trust/trust_delegation.md @@ -196,10 +196,9 @@ When initiating a repository, you will need the key and the passphrase of a loca Notary Canonical Root Key. If you have not initiated a repository before, and therefore don't have a Notary root key, `$ docker trust` will create one for you. -> **Important** +> [!IMPORTANT] > > Be sure to protect and back up your [Notary Canonical Root Key](trust_key_mng.md). -{ .important } ### Initiating the repository @@ -301,7 +300,7 @@ multiple contributor keys per delegation. The only prerequisite here is to make sure you use the same the delegation name, in this case `jeff`. Docker trust will automatically handle adding this new key to `targets/releases`. -> **Note** +> [!NOTE] > > You will need the passphrase for the repository key; this would have been > configured when you first initiated the repository. @@ -339,7 +338,7 @@ If you need to remove a delegation, including the contributor keys that are attached to the `targets/releases` role, you can use the `$ docker trust signer remove` command. -> **Note** +> [!NOTE] > > Tags that were signed by the removed delegation will need to be resigned > by an active delegation diff --git a/content/engine/security/trust/trust_key_mng.md b/content/engine/security/trust/trust_key_mng.md index 5c8af2274c..f930f241ae 100644 --- a/content/engine/security/trust/trust_key_mng.md +++ b/content/engine/security/trust/trust_key_mng.md @@ -43,11 +43,10 @@ All the Docker trust keys are stored encrypted using the passphrase you provide on creation. Even so, you should still take care of the location where you back them up. Good practice is to create two encrypted USB keys. -> **Warning** +> [!WARNING] > > It is very important that you back up your keys to a safe, secure location. The loss of the repository key is recoverable, but the loss of the root key is not. -{ .warning } The Docker client stores the keys in the `~/.docker/trust/private` directory. Before backing them up, you should `tar` them into an archive: @@ -69,12 +68,11 @@ Prior to Docker Engine 1.11, this feature was only in the experimental branch. ## Key loss -> **Warning** +> [!WARNING] > > If a publisher loses keys it means losing the ability to sign images for the repositories in question. If you lose a key, send an email to [Docker Hub Support](mailto:hub-support@docker.com). As a reminder, the loss of a root key is not recoverable. -{ .warning } This loss also requires manual intervention from every consumer that used a signed tag from this repository prior to the loss. @@ -92,4 +90,4 @@ the new key. * [Content trust in Docker](index.md) * [Automation with content trust](trust_automation.md) * [Delegations for content trust](trust_delegation.md) -* [Play in a content trust sandbox](trust_sandbox.md) \ No newline at end of file +* [Play in a content trust sandbox](trust_sandbox.md) diff --git a/content/engine/security/trust/trust_sandbox.md b/content/engine/security/trust/trust_sandbox.md index d6ef54d5f3..d1e56f93d5 100644 --- a/content/engine/security/trust/trust_sandbox.md +++ b/content/engine/security/trust/trust_sandbox.md @@ -289,4 +289,4 @@ When you are done, and want to clean up all the services you've started and any anonymous volumes that have been created, just run the following command in the directory where you've created your Docker Compose file: - $ docker compose down -v \ No newline at end of file + $ docker compose down -v diff --git a/content/engine/security/userns-remap.md b/content/engine/security/userns-remap.md index 790aee3a5e..bc58ded55a 100644 --- a/content/engine/security/userns-remap.md +++ b/content/engine/security/userns-remap.md @@ -34,7 +34,7 @@ outside of the namespace, the process is running as an unprivileged high-number UID on the host, which does not even map to a real user. This means the process has no privileges on the host system at all. -> **Note** +> [!NOTE] > > It is possible to assign multiple subordinate ranges for a given user or group > by adding multiple non-overlapping mappings for the same user or group in the @@ -47,13 +47,12 @@ specify an existing user and/or group, or you can specify `default`. If you specify `default`, a user and group `dockremap` is created and used for this purpose. -> **Warning** +> [!WARNING] > > Some distributions do not automatically add the new group to the > `/etc/subuid` and `/etc/subgid` files. If that's the case, you are may have > to manually edit these files and assign non-overlapping ranges. This step is > covered in [Prerequisites](#prerequisites). -{ .warning } It is very important that the ranges do not overlap, so that a process cannot gain access in a different namespace. On most Linux distributions, system utilities @@ -161,7 +160,7 @@ $ dockerd --userns-remap="testuser:testuser" } ``` - > **Note** + > [!NOTE] > > To use the `dockremap` user and have Docker create it for you, > set the value to `default` rather than `testuser`. diff --git a/content/engine/storage/_index.md b/content/engine/storage/_index.md index 063195c676..151bd6c31d 100644 --- a/content/engine/storage/_index.md +++ b/content/engine/storage/_index.md @@ -100,7 +100,7 @@ machine's filesystem having a specific directory structure available. If you are developing new Docker applications, consider using named volumes instead. You can't use Docker CLI commands to directly manage bind mounts. -> **Important** +> [!IMPORTANT] > > Bind mounts allow write access to files on the host by default. > @@ -109,13 +109,11 @@ You can't use Docker CLI commands to directly manage bind mounts. > modifying, or deleting important system files or directories. This is a > powerful ability which can have security implications, including impacting > non-Docker processes on the host system. -{ .important } -> **Tip** +> [!TIP] > > Working with large repositories or monorepos, or with virtual file systems that are no longer scaling with your codebase? > Check out [Synchronized file shares](/desktop/synchronized-file-sharing.md). It provides fast and flexible host-to-VM file sharing by enhancing bind mount performance through the use of synchronized filesystem caches. -{ .tip } ### tmpfs diff --git a/content/engine/storage/bind-mounts.md b/content/engine/storage/bind-mounts.md index 8816970522..29c98bdb78 100644 --- a/content/engine/storage/bind-mounts.md +++ b/content/engine/storage/bind-mounts.md @@ -24,11 +24,10 @@ manage bind mounts. ![Bind mounts on the Docker host](images/types-of-mounts-bind.webp?w=450&h=300) -> **Tip** +> [!TIP] > > Working with large repositories or monorepos, or with virtual file systems that are no longer scaling with your codebase? > Check out [Synchronized file shares](/desktop/synchronized-file-sharing.md). It provides fast and flexible host-to-VM file sharing by enhancing bind mount performance through the use of synchronized filesystem caches. -{ .tip } ## Choose the -v or --mount flag @@ -41,7 +40,6 @@ syntax separates them. Here is a comparison of the syntax for each flag. > New users should use the `--mount` syntax. Experienced users may > be more familiar with the `-v` or `--volume` syntax, but are encouraged to > use `--mount`, because research has shown it to be easier to use. -{ .tip } - `-v` or `--volume`: Consists of three fields, separated by colon characters (`:`). The fields must be in the correct order, and the meaning of each field @@ -311,10 +309,9 @@ propagation setting has a recursive counterpoint. In the case of recursion, consider that `/tmp/a` is also mounted as `/foo`. The propagation settings control whether `/mnt/a` and/or `/tmp/a` would exist. -> **Warning** +> [!WARNING] > > Mount propagation doesn't work with Docker Desktop. -{ .warning } | Propagation setting | Description | |:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -381,12 +378,11 @@ Use extreme caution with these options. Bind-mounting a system directory such as `/home` or `/usr` with the `Z` option renders your host machine inoperable and you may need to relabel the host machine files by hand. -> **Important** +> [!IMPORTANT] > > When using bind mounts with services, selinux labels > (`:Z` and `:z`), as well as `:ro` are ignored. See > [moby/moby #32579](https://github.com/moby/moby/issues/32579) for details. -{ .important } This example sets the `z` option to specify that multiple containers can share the bind mount's contents: diff --git a/content/engine/storage/containerd.md b/content/engine/storage/containerd.md index de6c9c3048..7a2feb9efe 100644 --- a/content/engine/storage/containerd.md +++ b/content/engine/storage/containerd.md @@ -6,7 +6,7 @@ aliases: - /storage/containerd/ --- -> **Note** +> [!NOTE] > > The containerd image store is an experimental feature of Docker Engine. > If you're using Docker Desktop, refer to the instructions on the diff --git a/content/engine/storage/drivers/_index.md b/content/engine/storage/drivers/_index.md index 8e36dad14d..aeaea1e86b 100644 --- a/content/engine/storage/drivers/_index.md +++ b/content/engine/storage/drivers/_index.md @@ -96,7 +96,7 @@ writable container layer. Each storage driver handles the implementation differently, but all drivers use stackable image layers and the copy-on-write (CoW) strategy. -> **Note** +> [!NOTE] > > Use Docker volumes if you need multiple containers to have shared access to > the exact same data. Refer to the [volumes section](../volumes.md) to learn @@ -358,7 +358,7 @@ layers are the same. to an image registry. Shared image layers can therefore reduce network bandwidth and storage. - > **Tip** + > [!TIP] > > Format output of Docker commands with the `--format` option. > @@ -371,7 +371,6 @@ layers are the same. > [format command and log output section](/engine/cli/formatting.md). > We also pretty-printed the JSON output using the [`jq` utility](https://stedolan.github.io/jq/) > for readability. - { .tip } ### Copying makes containers efficient @@ -403,7 +402,7 @@ container's thin writable top layer. Note that changing the metadata of files, for example, changing file permissions or ownership of a file, can also result in a `copy_up` operation, therefore duplicating the file to the writable layer. -> **Tip** +> [!TIP] > > Use volumes for write-heavy applications. > @@ -417,7 +416,6 @@ in a `copy_up` operation, therefore duplicating the file to the writable layer. > among containers and don't increase the size of your container's writable > layer. Refer to the [use volumes](../volumes.md) section to learn about > volumes. -{ .tip } A `copy_up` operation can incur a noticeable performance overhead. This overhead is different depending on which storage driver is in use. Large files, @@ -467,7 +465,7 @@ examines how much room they take up. {{< accordion title="Advanced: metadata and logs storage used for containers" >}} - > **Note** + > [!NOTE] > > This step requires a Linux machine, and doesn't work on Docker Desktop, as > it requires access to the Docker Daemon's file storage. diff --git a/content/engine/storage/drivers/aufs-driver.md b/content/engine/storage/drivers/aufs-driver.md index 002a84b3ab..36368fb073 100644 --- a/content/engine/storage/drivers/aufs-driver.md +++ b/content/engine/storage/drivers/aufs-driver.md @@ -13,7 +13,6 @@ aliases: > v24.0. If you are using AufS, you must migrate to a supported storage driver > before upgrading to Docker Engine v24.0. Read the [Docker storage drivers](select-storage-driver.md) > page for supported storage drivers. -{ .warning } AUFS is a *union filesystem*. The `aufs` storage driver was previously the default storage driver used for managing images and layers on Docker for Ubuntu, and for @@ -107,7 +106,7 @@ Status: Downloaded newer image for ubuntu:latest #### The image layers -> **Warning**: Do not directly manipulate any files or directories within +> [!WARNING]: Do not directly manipulate any files or directories within > `/var/lib/docker/`. These files and directories are managed by Docker. All of the information about the image and container layers is stored in diff --git a/content/engine/storage/drivers/btrfs-driver.md b/content/engine/storage/drivers/btrfs-driver.md index 7ca6987a96..91d46af949 100644 --- a/content/engine/storage/drivers/btrfs-driver.md +++ b/content/engine/storage/drivers/btrfs-driver.md @@ -18,7 +18,7 @@ combine multiple physical block devices into a single Btrfs filesystem. This page refers to Docker's Btrfs storage driver as `btrfs` and the overall Btrfs Filesystem as Btrfs. -> **Note** +> [!NOTE] > > The `btrfs` storage driver is only supported with Docker Engine CE on SLES, > Ubuntu, and Debian systems. @@ -87,7 +87,7 @@ This procedure is essentially identical on SLES and Ubuntu. $ sudo mount -t btrfs /dev/xvdf /var/lib/docker ``` - > **Note** + > [!NOTE] > > Make the change permanent across reboots by adding an entry to > `/etc/fstab`. @@ -151,7 +151,7 @@ $ sudo btrfs device add /dev/svdh /var/lib/docker $ sudo btrfs filesystem balance /var/lib/docker ``` -> **Note** +> [!NOTE] > > While you can do these operations with Docker running, performance suffers. > It might be best to plan an outage window to balance the Btrfs filesystem. @@ -260,7 +260,7 @@ filesystem itself and the space is reclaimed. There are several factors that influence Docker's performance under the `btrfs` storage driver. -> **Note** +> [!NOTE] > > Many of these factors are mitigated by using Docker volumes for write-heavy > workloads, rather than relying on storing data in the container's writable diff --git a/content/engine/storage/drivers/device-mapper-driver.md b/content/engine/storage/drivers/device-mapper-driver.md index 0b401618cd..f3c1bc0950 100644 --- a/content/engine/storage/drivers/device-mapper-driver.md +++ b/content/engine/storage/drivers/device-mapper-driver.md @@ -13,7 +13,6 @@ aliases: > you must migrate to a supported storage driver before upgrading to Docker > Engine v25.0. Read the [Docker storage drivers](select-storage-driver.md) > page for supported storage drivers. -{ .warning } Device Mapper is a kernel-based framework that underpins many advanced volume management technologies on Linux. Docker's `devicemapper` storage driver @@ -146,7 +145,7 @@ After you have satisfied the [prerequisites](#prerequisites), follow the steps below to configure Docker to use the `devicemapper` storage driver in `direct-lvm` mode. -> **Warning**: Changing the storage driver makes any containers you have already +> [!WARNING]: Changing the storage driver makes any containers you have already created inaccessible on the local system. Use `docker save` to save containers, and push existing images to Docker Hub or a private repository, so you do not need to recreate them later. @@ -192,7 +191,7 @@ See all storage options for each storage driver in the Restart Docker for the changes to take effect. Docker invokes the commands to configure the block device for you. -> **Warning**: Changing these values after Docker has prepared the block device +> [!WARNING]: Changing these values after Docker has prepared the block device > for you is not supported and causes an error. You still need to [perform periodic maintenance tasks](#manage-devicemapper). @@ -228,7 +227,7 @@ assumes that the Docker daemon is in the `stopped` state. 4. Create a physical volume on your block device from step 1, using the `pvcreate` command. Substitute your device name for `/dev/xvdf`. - > **Warning**: The next few steps are destructive, so be sure that you have + > [!WARNING]: The next few steps are destructive, so be sure that you have > specified the correct device! ```console @@ -652,7 +651,7 @@ $ sudo lvchange -ay docker/thinpool ## How the `devicemapper` storage driver works -> **Warning**: Do not directly manipulate any files or directories within +> [!WARNING]: Do not directly manipulate any files or directories within > `/var/lib/docker/`. These files and directories are managed by Docker. Use the `lsblk` command to see the devices and their pools, from the operating diff --git a/content/engine/storage/drivers/overlayfs-driver.md b/content/engine/storage/drivers/overlayfs-driver.md index 97d98b86cc..03a925a9f6 100644 --- a/content/engine/storage/drivers/overlayfs-driver.md +++ b/content/engine/storage/drivers/overlayfs-driver.md @@ -11,7 +11,7 @@ OverlayFS is a union filesystem. This page refers to the Linux kernel driver as `OverlayFS` and to the Docker storage driver as `overlay2`. -> **Note** +> [!NOTE] > > For `fuse-overlayfs` driver, check [Rootless mode documentation](/engine/security/rootless.md). @@ -117,11 +117,10 @@ filesystem. After downloading a five-layer image using `docker pull ubuntu`, you can see six directories under `/var/lib/docker/overlay2`. -> **Warning** +> [!WARNING] > > Don't directly manipulate any files or directories within > `/var/lib/docker/`. These files and directories are managed by Docker. -{ .warning } ```console $ ls -l /var/lib/docker/overlay2 @@ -246,11 +245,10 @@ Each image layer has its own directory within `/var/lib/docker/overlay/`, which contains its contents, as shown in the following example. The image layer IDs don't correspond to the directory IDs. -> **Warning** +> [!WARNING] > > Don't directly manipulate any files or directories within > `/var/lib/docker/`. These files and directories are managed by Docker. -{ .warning } ```console $ ls -l /var/lib/docker/overlay/ diff --git a/content/engine/storage/drivers/select-storage-driver.md b/content/engine/storage/drivers/select-storage-driver.md index f8aeeaa000..6e72d0210e 100644 --- a/content/engine/storage/drivers/select-storage-driver.md +++ b/content/engine/storage/drivers/select-storage-driver.md @@ -48,7 +48,7 @@ the final decision. ## Supported storage drivers per Linux distribution -> **Note** +> [!NOTE] > > Modifying the storage driver by editing the daemon configuration file isn't > supported on Docker Desktop. Only the default `overlay2` driver or the @@ -178,14 +178,13 @@ To change the storage driver, see the specific instructions for the new storage driver. Some drivers require additional configuration, including configuration to physical or logical disks on the Docker host. -> **Important** +> [!IMPORTANT] > > When you change the storage driver, any existing images and containers become > inaccessible. This is because their layers can't be used by the new storage > driver. If you revert your changes, you can access the old images and containers > again, but any that you pulled or created using the new driver are then > inaccessible. -{ .important } ## Related information diff --git a/content/engine/storage/drivers/zfs-driver.md b/content/engine/storage/drivers/zfs-driver.md index 117045c55f..da0fd8f1f6 100644 --- a/content/engine/storage/drivers/zfs-driver.md +++ b/content/engine/storage/drivers/zfs-driver.md @@ -36,7 +36,7 @@ use unless you have substantial experience with ZFS on Linux. and push existing images to Docker Hub or a private repository, so that you do not need to re-create them later. -> **Note** +> [!NOTE] > > There is no need to use `MountFlags=slave` because `dockerd` and `containerd` > are in different mount namespaces. diff --git a/content/engine/storage/volumes.md b/content/engine/storage/volumes.md index 4aabf9ac50..04b12aefea 100644 --- a/content/engine/storage/volumes.md +++ b/content/engine/storage/volumes.md @@ -83,7 +83,7 @@ If you need to specify volume driver options, you must use `--mount`. - The `volume-opt` option, which can be specified more than once, takes a key-value pair consisting of the option name and its value. -> **Warning** +> [!WARNING] > > If your volume driver accepts a comma-separated list as an option, > you must escape the value from the outer CSV parser. To escape a `volume-opt`, @@ -99,7 +99,6 @@ If you need to specify volume driver options, you must use `--mount`. > --name myservice \ > > ``` -{ .warning } The examples below show both the `--mount` and `-v` syntax where possible, with `--mount` first. @@ -500,7 +499,7 @@ The following example specifies an SSH password. However, if the two hosts have shared keys configured, you can exclude the password. Each volume driver may have zero or more configurable options. -> **Note** +> [!NOTE] > > If the volume driver requires you to pass any options, > you must use the `--mount` flag to mount the volume, and not `-v`. @@ -558,12 +557,11 @@ You can mount a block storage device, such as an external drive or a drive parti The following example shows how to create and use a file as a block storage device, and how to mount the block device as a container volume. -> **Important** +> [!IMPORTANT] > > The following procedure is only an example. > The solution illustrated here isn't recommended as a general practice. > Don't attempt this approach unless you're confident about what you're doing. -{ .important } #### How mounting block devices works @@ -623,7 +621,7 @@ The filesystem support of your system depends on the version of the Linux kernel /dev/loop5 ``` - > **Note** + > [!NOTE] > > `losetup` creates an ephemeral loop device that's removed after > system reboot, or manually removed with `losetup -d`. @@ -710,7 +708,7 @@ the Docker Engine removes the `/foo` volume but not the `awesome` volume. $ docker run --rm -v /foo -v awesome:/bar busybox top ``` -> **Note** +> [!NOTE] > > If another container binds the volumes with > `--volumes-from`, the volume definitions are _copied_ and the diff --git a/content/engine/swarm/_index.md b/content/engine/swarm/_index.md index 33c4cd7716..11229e344c 100644 --- a/content/engine/swarm/_index.md +++ b/content/engine/swarm/_index.md @@ -137,4 +137,4 @@ roll back to a previous version of the service. * [service rm](../../reference/cli/docker/service/rm.md) * [service scale](../../reference/cli/docker/service/scale.md) * [service ps](../../reference/cli/docker/service/ps.md) - * [service update](../../reference/cli/docker/service/update.md) \ No newline at end of file + * [service update](../../reference/cli/docker/service/update.md) diff --git a/content/engine/swarm/admin_guide.md b/content/engine/swarm/admin_guide.md index dcdc47036a..e28b5de003 100644 --- a/content/engine/swarm/admin_guide.md +++ b/content/engine/swarm/admin_guide.md @@ -254,7 +254,7 @@ You can back up the swarm using any manager. Use the following procedure. results are less predictable when restoring. While the manager is down, other nodes continue generating swarm data that is not part of this backup. - > **Note** + > [!NOTE] > > Be sure to maintain the quorum of swarm managers. During the > time that a manager is shut down, your swarm is more vulnerable to @@ -285,7 +285,7 @@ restore the data to a new swarm. 3. Restore the `/var/lib/docker/swarm` directory with the contents of the backup. - > **Note** + > [!NOTE] > > The new node uses the same encryption key for on-disk > storage as the old one. It is not possible to change the on-disk storage @@ -396,4 +396,4 @@ balance of your service across nodes. See also [`docker service scale`](../../reference/cli/docker/service/scale.md) and -[`docker service ps`](../../reference/cli/docker/service/ps.md). \ No newline at end of file +[`docker service ps`](../../reference/cli/docker/service/ps.md). diff --git a/content/engine/swarm/configs.md b/content/engine/swarm/configs.md index cfccca7eb3..c86de19d89 100644 --- a/content/engine/swarm/configs.md +++ b/content/engine/swarm/configs.md @@ -18,7 +18,7 @@ any time, and services can share a config. You can even use configs in conjunction with environment variables or labels, for maximum flexibility. Config values can be generic strings or binary content (up to 500 kb in size). -> **Note** +> [!NOTE] > > Docker configs are only available to swarm services, not to > standalone containers. To use this feature, consider adapting your container @@ -123,7 +123,7 @@ Use these links to read about specific commands, or continue to the This section includes graduated examples which illustrate how to use Docker configs. -> **Note** +> [!NOTE] > > These examples use a single-engine swarm and unscaled services for > simplicity. The examples use Linux containers, but Windows containers also @@ -665,4 +665,4 @@ configuration file. ``` You have now updated your `nginx` service's configuration without the need to -rebuild its image. \ No newline at end of file +rebuild its image. diff --git a/content/engine/swarm/how-swarm-mode-works/nodes.md b/content/engine/swarm/how-swarm-mode-works/nodes.md index 718812f482..294b7b43f9 100644 --- a/content/engine/swarm/how-swarm-mode-works/nodes.md +++ b/content/engine/swarm/how-swarm-mode-works/nodes.md @@ -49,7 +49,6 @@ Docker recommends a maximum of seven manager nodes for a swarm. > > Adding more managers does NOT mean increased > scalability or higher performance. In general, the opposite is true. - { .important } ## Worker nodes @@ -84,4 +83,4 @@ You can also demote a manager node to a worker node. See ## Learn more * Read about how Swarm mode [services](services.md) work. -* Learn how [PKI](pki.md) works in Swarm mode. \ No newline at end of file +* Learn how [PKI](pki.md) works in Swarm mode. diff --git a/content/engine/swarm/how-swarm-mode-works/pki.md b/content/engine/swarm/how-swarm-mode-works/pki.md index 8ba21bc215..8dd4ab3708 100644 --- a/content/engine/swarm/how-swarm-mode-works/pki.md +++ b/content/engine/swarm/how-swarm-mode-works/pki.md @@ -60,7 +60,7 @@ reference for details. ## Rotating the CA certificate -> **Note** +> [!NOTE] > > Mirantis Kubernetes Engine (MKE), formerly known as Docker UCP, provides an external > certificate manager service for the swarm. If you run swarm on MKE, you shouldn't @@ -103,4 +103,4 @@ root CA, and do not contain any intermediates. ## Learn More * Read about how [nodes](nodes.md) work. -* Learn how Swarm mode [services](services.md) work. \ No newline at end of file +* Learn how Swarm mode [services](services.md) work. diff --git a/content/engine/swarm/how-swarm-mode-works/services.md b/content/engine/swarm/how-swarm-mode-works/services.md index 81a854126d..1392e8a9bf 100644 --- a/content/engine/swarm/how-swarm-mode-works/services.md +++ b/content/engine/swarm/how-swarm-mode-works/services.md @@ -74,11 +74,10 @@ A service may be configured in such a way that no node currently in the swarm can run its tasks. In this case, the service remains in state `pending`. Here are a few examples of when a service might remain in state `pending`. -> **Tip** +> [!TIP] > If your only intention is to prevent a service from > being deployed, scale the service to 0 instead of trying to configure it in > such a way that it remains in `pending`. -{ .tip } - If all nodes are paused or drained, and you create a service, it is pending until a node becomes available. In reality, the first node to become @@ -122,4 +121,4 @@ in black. ## Learn more * Read about how Swarm mode [nodes](nodes.md) work. -* Learn how [PKI](pki.md) works in Swarm mode. \ No newline at end of file +* Learn how [PKI](pki.md) works in Swarm mode. diff --git a/content/engine/swarm/how-swarm-mode-works/swarm-task-states.md b/content/engine/swarm/how-swarm-mode-works/swarm-task-states.md index 2bb67c1461..06ccbce3d8 100644 --- a/content/engine/swarm/how-swarm-mode-works/swarm-task-states.md +++ b/content/engine/swarm/how-swarm-mode-works/swarm-task-states.md @@ -59,4 +59,4 @@ j91iahr8s74p \_ webserver.1 nginx UbuntuVM Shutdown Failed 50 s ## Where to go next -- [Learn about swarm tasks](https://github.com/docker/swarmkit/blob/master/design/task_model.md) \ No newline at end of file +- [Learn about swarm tasks](https://github.com/docker/swarmkit/blob/master/design/task_model.md) diff --git a/content/engine/swarm/ingress.md b/content/engine/swarm/ingress.md index 9d09e82604..200c099be1 100644 --- a/content/engine/swarm/ingress.md +++ b/content/engine/swarm/ingress.md @@ -42,7 +42,7 @@ $ docker service create \ ``` -> **Note** +> [!NOTE] > > The older form of this syntax is a colon-separated string, where > the published port is first and the target port is second, such as diff --git a/content/engine/swarm/join-nodes.md b/content/engine/swarm/join-nodes.md index c6c482d249..a367767c83 100644 --- a/content/engine/swarm/join-nodes.md +++ b/content/engine/swarm/join-nodes.md @@ -99,4 +99,4 @@ This node joined a swarm as a manager. ## Learn More * `swarm join` [command line reference](../../reference/cli/docker/swarm/join.md) -* [Swarm mode tutorial](swarm-tutorial/index.md) \ No newline at end of file +* [Swarm mode tutorial](swarm-tutorial/index.md) diff --git a/content/engine/swarm/key-concepts.md b/content/engine/swarm/key-concepts.md index 830d484153..9b4a92c6c7 100644 --- a/content/engine/swarm/key-concepts.md +++ b/content/engine/swarm/key-concepts.md @@ -108,4 +108,4 @@ the service. ## What's next? * Read the [Swarm mode overview](index.md). -* Get started with the [Swarm mode tutorial](swarm-tutorial/index.md). \ No newline at end of file +* Get started with the [Swarm mode tutorial](swarm-tutorial/index.md). diff --git a/content/engine/swarm/manage-nodes.md b/content/engine/swarm/manage-nodes.md index 97d6a86728..f8ef32518c 100644 --- a/content/engine/swarm/manage-nodes.md +++ b/content/engine/swarm/manage-nodes.md @@ -157,7 +157,7 @@ You can promote a worker node to the manager role. This is useful when a manager node becomes unavailable or if you want to take a manager offline for maintenance. Similarly, you can demote a manager node to the worker role. -> **Note** +> [!NOTE] > > Regardless of your reason to promote or demote > a node, you must always maintain a quorum of manager nodes in the @@ -195,7 +195,7 @@ install the plugin on each node or script the installation. You can also deploy the plugin in a similar way as a global service using the Docker API, by specifying a `PluginSpec` instead of a `ContainerSpec`. -> **Note** +> [!NOTE] > > There is currently no way to deploy a plugin to a swarm using the > Docker CLI or Docker Compose. In addition, it is not possible to install diff --git a/content/engine/swarm/networking.md b/content/engine/swarm/networking.md index 9be92deb6c..35ba0a7f86 100644 --- a/content/engine/swarm/networking.md +++ b/content/engine/swarm/networking.md @@ -49,10 +49,9 @@ The following three network concepts are important to swarm services: join a swarm. Most users do not need to customize its configuration, but Docker allows you to do so. -> **Tip** +> [!TIP] > > See also [Networking overview](/engine/network/_index.md) for more details about Swarm networking in general. -{ .tip } ## Firewall considerations @@ -231,7 +230,7 @@ Multiple pools can be configured if discontiguous address space is required. How The default mask length can be configured and is the same for all networks. It is set to `/24` by default. To change the default subnet mask length, use the `--default-addr-pool-mask-length` command line option. -> **Note** +> [!NOTE] > > Default address pools can only be configured on `swarm init` and cannot be altered after cluster creation. @@ -256,7 +255,7 @@ network create`. This enables IPSEC encryption at the level of the vxlan. This encryption imposes a non-negligible performance penalty, so you should test this option before using it in production. -> **Note** +> [!NOTE] > > You must [customize the automatically created ingress](#customize-ingress) > to enable encryption. By default, all ingress traffic is unencrypted, as encryption @@ -365,7 +364,7 @@ services which publish ports, such as a WordPress service which publishes port my-ingress ``` - > **Note** + > [!NOTE] > > You can name your `ingress` network something other than > `ingress`, but you can only have one. An attempt to create a second one diff --git a/content/engine/swarm/raft.md b/content/engine/swarm/raft.md index 08b43b6fe9..3a67d11187 100644 --- a/content/engine/swarm/raft.md +++ b/content/engine/swarm/raft.md @@ -35,4 +35,4 @@ the properties inherent to distributed systems: and the [Raft Consensus Algorithm paper](https://www.usenix.org/system/files/conference/atc14/atc14-paper-ongaro.pdf)) - Mutual exclusion through the leader election process - Cluster membership management -- Globally consistent object sequencing and CAS (compare-and-swap) primitives \ No newline at end of file +- Globally consistent object sequencing and CAS (compare-and-swap) primitives diff --git a/content/engine/swarm/secrets.md b/content/engine/swarm/secrets.md index c17b614ed9..e18430a1e3 100644 --- a/content/engine/swarm/secrets.md +++ b/content/engine/swarm/secrets.md @@ -26,7 +26,7 @@ runtime but you don't want to store in the image or in source control, such as: - Other important data such as the name of a database or internal server - Generic strings or binary content (up to 500 kb in size) -> **Note** +> [!NOTE] > > Docker secrets are only available to swarm services, not to > standalone containers. To use this feature, consider adapting your container @@ -133,7 +133,7 @@ easier to use Docker secrets. To find out how to modify your own images in a similar way, see [Build support for Docker Secrets into your images](#build-support-for-docker-secrets-into-your-images). -> **Note** +> [!NOTE] > > These examples use a single-Engine swarm and unscaled services for > simplicity. The examples use Linux containers, but Windows containers also @@ -305,7 +305,7 @@ This example assumes that you have PowerShell installed. microsoft/iis:nanoserver ``` - > **Note** + > [!NOTE] > > There is technically no reason to use secrets for this > example; [configs](configs.md) are a better fit. This example is @@ -472,7 +472,7 @@ generate the site key and certificate, name the files `site.key` and actually starts, so you don't need to rebuild your image if you change the Nginx configuration. - > **Note** + > [!NOTE] > > Normally you would create a Dockerfile which copies the `site.conf` > into place, build the image, and run a container using your custom image. @@ -630,7 +630,7 @@ This example illustrates some techniques to use Docker secrets to avoid saving sensitive credentials within your image or passing them directly on the command line. -> **Note** +> [!NOTE] > > This example uses a single-Engine swarm for simplicity, and uses a > single-node MySQL service because a single MySQL server instance cannot be @@ -648,7 +648,7 @@ line. password. You can use another command to generate the password if you choose. - > **Note** + > [!NOTE] > > After you create a secret, you cannot update it. You can only > remove and re-create it, and you cannot remove a secret that a service is @@ -834,7 +834,7 @@ This example builds upon the previous one. In this scenario, you create a new secret with a new MySQL password, update the `mysql` and `wordpress` services to use it, then remove the old secret. -> **Note** +> [!NOTE] > > Changing the password on a MySQL database involves running extra > queries or commands, as opposed to just changing a single environment variable @@ -871,7 +871,7 @@ use it, then remove the old secret. Even though the MySQL service has access to both the old and new secrets now, the MySQL password for the WordPress user has not yet been changed. - > **Note** + > [!NOTE] > > This example does not rotate the MySQL `root` password. @@ -968,7 +968,7 @@ their values from a file (`WORDPRESS_DB_PASSWORD_FILE`). This strategy ensures that backward compatibility is preserved, while allowing your container to read the information from a Docker-managed secret instead of being passed directly. -> **Note** +> [!NOTE] > > Docker secrets do not set environment variables directly. This was a > conscious decision, because environment variables can unintentionally be leaked diff --git a/content/engine/swarm/services.md b/content/engine/swarm/services.md index 9236ec0d63..a9c84c391d 100644 --- a/content/engine/swarm/services.md +++ b/content/engine/swarm/services.md @@ -76,7 +76,7 @@ For more details about image tag resolution, see ### gMSA for Swarm -> **Note** +> [!NOTE] > > This example only works for a Windows container. @@ -122,7 +122,7 @@ nodes are able to log into the registry and pull the image. In Enterprise Edition 3.0, security is improved through the centralized distribution and management of Group Managed Service Account(gMSA) credentials using Docker config functionality. Swarm now allows using a Docker config as a gMSA credential spec, which reduces the burden of distributing credential specs to the nodes on which they are used. -> **Note** +> [!NOTE] > > This option is only applicable to services using Windows containers. @@ -304,7 +304,7 @@ updated. This feature is particularly important if you do use often-changing tag such as `latest`, because it ensures that all service tasks use the same version of the image. -> **Note**> +> [!NOTE]> > > If [content trust](../security/trust/index.md) is > enabled, the client actually resolves the image's tag to a digest before @@ -356,7 +356,7 @@ When you run `service update` with the `--image` flag, the swarm manager queries Docker Hub or your private Docker registry for the digest the tag currently points to and updates the service tasks to use that digest. -> **Note** +> [!NOTE] > > If you use [content trust](../security/trust/index.md), the Docker > client resolves image and the swarm manager receives the image and digest, @@ -474,7 +474,7 @@ control of the process for routing requests to your service's tasks. To publish a service's port directly on the node where it is running, use the `mode=host` option to the `--publish` flag. -> **Note** +> [!NOTE] > > If you publish a service's ports directly on the swarm node using > `mode=host` and also set `published=` this creates an implicit @@ -508,7 +508,7 @@ You can reach the nginx server on port 8080 of every swarm node. If you add a node to the swarm, a nginx task is started on it. You cannot start another service or container on any swarm node which binds to port 8080. -> **Note** +> [!NOTE] > > This is a purely illustrative example. Creating an application-layer > routing framework for a multi-tiered service is complex and out of scope for @@ -566,10 +566,9 @@ flag. For more information, see ### Customize a service's isolation mode -> **Important** +> [!IMPORTANT] > > This setting applies to Windows hosts only and is ignored for Linux hosts. -{ .important } Docker allows you to specify a swarm service's isolation mode. The isolation mode can be one of the following: @@ -582,7 +581,7 @@ mode. The isolation mode can be one of the following: - `process`: Run the service tasks as a separate process on the host. - > **Note** + > [!NOTE] > > `process` isolation mode is only supported on Windows Server. > Windows 10 only supports `hyperv` isolation mode. @@ -749,7 +748,7 @@ Placement preferences are not strictly enforced. If no node has the label you specify in your preference, the service is deployed as though the preference were not set. -> **Note** +> [!NOTE] > > Placement preferences are ignored for global services. @@ -766,7 +765,7 @@ $ docker service create \ redis:3.0.6 ``` -> **Note** +> [!NOTE] > > Nodes which are missing the label used to spread still receive > task assignments. As a group, these nodes receive tasks in equal @@ -981,7 +980,7 @@ The following examples show bind mount syntax: ``` -> **Important** +> [!IMPORTANT] > > Bind mounts can be useful but they can also cause problems. In > most cases, it is recommended that you architect your application such that @@ -999,7 +998,6 @@ The following examples show bind mount syntax: > - Host bind mounts are non-portable. When you use bind mounts, there is no > guarantee that your application runs the same way in development as it does > in production. -{ .important } ### Create services using templates diff --git a/content/engine/swarm/stack-deploy.md b/content/engine/swarm/stack-deploy.md index 4d31b14c9a..dbad9b3612 100644 --- a/content/engine/swarm/stack-deploy.md +++ b/content/engine/swarm/stack-deploy.md @@ -17,7 +17,7 @@ To run through this tutorial, you need: [Swarm mode key concepts](key-concepts.md) and [How services work](how-swarm-mode-works/services.md). - > **Note** + > [!NOTE] > > If you're trying things out on a local development environment, > you can put your engine into Swarm mode with `docker swarm init`. diff --git a/content/engine/swarm/swarm-mode.md b/content/engine/swarm/swarm-mode.md index 50d4d46de5..2eb7e392b3 100644 --- a/content/engine/swarm/swarm-mode.md +++ b/content/engine/swarm/swarm-mode.md @@ -215,4 +215,4 @@ To add a worker to this swarm, run the following command: * [Join nodes to a swarm](join-nodes.md) * `swarm init` [command line reference](../../reference/cli/docker/swarm/init.md) -* [Swarm mode tutorial](swarm-tutorial/index.md) \ No newline at end of file +* [Swarm mode tutorial](swarm-tutorial/index.md) diff --git a/content/engine/swarm/swarm-tutorial/drain-node.md b/content/engine/swarm/swarm-tutorial/drain-node.md index 8adb354b7d..b13c10be68 100644 --- a/content/engine/swarm/swarm-tutorial/drain-node.md +++ b/content/engine/swarm/swarm-tutorial/drain-node.md @@ -14,13 +14,12 @@ availability. `Drain` availability prevents a node from receiving new tasks from the swarm manager. It also means the manager stops tasks running on the node and launches replica tasks on a node with `Active` availability. -> **Important**: +> [!IMPORTANT]: > > Setting a node to `Drain` does not remove standalone containers from that node, > such as those created with `docker run`, `docker compose up`, or the Docker Engine > API. A node's status, including `Drain`, only affects the node's ability to schedule > swarm service workloads. -{ .important } 1. If you haven't already, open a terminal and ssh into the machine where you run your manager node. For example, the tutorial uses a machine named diff --git a/content/engine/swarm/swarm-tutorial/inspect-service.md b/content/engine/swarm/swarm-tutorial/inspect-service.md index 3f14e56d79..af1412d00b 100644 --- a/content/engine/swarm/swarm-tutorial/inspect-service.md +++ b/content/engine/swarm/swarm-tutorial/inspect-service.md @@ -38,7 +38,6 @@ the Docker CLI to see details about the service running in the swarm. > > To return the service details in json format, run the same command without the `--pretty` flag. - { .tip } ```console [manager1]$ docker service inspect helloworld @@ -114,7 +113,6 @@ the Docker CLI to see details about the service running in the swarm. > > If `helloworld` is running on a node other than your manager node, you must ssh to that node. - { .tip } ```console [worker2]$ docker ps diff --git a/content/engine/swarm/swarm-tutorial/scale-service.md b/content/engine/swarm/swarm-tutorial/scale-service.md index b146684f2e..7d4a2a0191 100644 --- a/content/engine/swarm/swarm-tutorial/scale-service.md +++ b/content/engine/swarm/swarm-tutorial/scale-service.md @@ -62,4 +62,4 @@ the service. Containers running in a service are called tasks. At this point in the tutorial, you're finished with the `helloworld` service. Next, you'll delete the service -{{< button text="Delete the service" url="delete-service.md" >}} \ No newline at end of file +{{< button text="Delete the service" url="delete-service.md" >}} diff --git a/content/engine/swarm/swarm_manager_locking.md b/content/engine/swarm/swarm_manager_locking.md index 46f3f48514..cba46065e3 100644 --- a/content/engine/swarm/swarm_manager_locking.md +++ b/content/engine/swarm/swarm_manager_locking.md @@ -21,7 +21,7 @@ When Docker restarts, you must key encryption key generated by Docker when the swarm was locked. You can rotate this key encryption key at any time. -> **Note** +> [!NOTE] > > You don't need to unlock the swarm when a new node joins the swarm, > because the key is propagated to it over mutual TLS. @@ -152,9 +152,8 @@ Please remember to store this key in a password manager, since without it you will not be able to restart the manager. ``` -> **Warning** +> [!WARNING] > > When you rotate the unlock key, keep a record of the old key > around for a few minutes, so that if a manager goes down before it gets the new > key, it may still be unlocked with the old one. -{ .warning } \ No newline at end of file diff --git a/content/engine/tutorials/networkingcontainers.md b/content/engine/tutorials/networkingcontainers.md index dc08a0c8b4..4c98af9e63 100644 --- a/content/engine/tutorials/networkingcontainers.md +++ b/content/engine/tutorials/networkingcontainers.md @@ -211,4 +211,4 @@ The `ping` shows it is contacting a different IP address, the address on the `my ## Next steps -Now that you know how to network containers, see [how to manage data in containers](/engine/storage/volumes.md). \ No newline at end of file +Now that you know how to network containers, see [how to manage data in containers](/engine/storage/volumes.md). diff --git a/content/extensions/extensions-sdk/architecture/_index.md b/content/extensions/extensions-sdk/architecture/_index.md index 31b215a93c..eefdd9b12f 100644 --- a/content/extensions/extensions-sdk/architecture/_index.md +++ b/content/extensions/extensions-sdk/architecture/_index.md @@ -34,12 +34,11 @@ Every time users click on the **Extensions** tab, Docker Desktop initializes the The frontend can invoke `docker` commands, communicate with the extension backend, or invoke extension executables deployed on the host, through the [Extensions SDK](https://www.npmjs.com/package/@docker/extension-api-client). -> **Tip** +> [!TIP] > > The `docker extension init` generates a React based extension. But you can still use it as a starting point for > your own extension and use any other frontend framework, like Vue, Angular, Svelte, etc. or event stay with > vanilla Javascript. -{ .tip } Learn more about [building a frontend](../build/frontend-extension-tutorial.md) for your extension. @@ -54,11 +53,10 @@ Alongside a frontend application, extensions can also contain one or many backen - To access specific resources in the Docker Desktop VM, for example by mounting folders in the compose file -> **Tip** +> [!TIP] > > The `docker extension init` generates a Go backend. But you can still use it as a starting point for > your own extension and use any other language like Node.js, Python, Java, .Net, or any other language and framework. -{ .tip } Usually, the backend is made of one container that runs within the Docker Desktop VM. Internally, Docker Desktop creates a Docker Compose project, creates the container from the `image` option of the `vm` section of the `metadata.json`, and @@ -70,7 +68,7 @@ that can't be expressed just with a Docker image. The `compose.yml` file can als needed by the extension, like a database or a message broker. Note that, if the Compose file defines many services, the SDK can only contact the first of them. -> **Note** +> [!NOTE] > > In some cases, it is useful to also interact with the Docker engine from the backend. > See [How to use the Docker socket](../guides/use-docker-socket-from-backend.md) from the backend. @@ -108,4 +106,4 @@ and Linux. Multi arch images will also need to include binaries built for the ri See the [host metadata section](metadata.md#host-section) for more details. -Learn how to [invoke host binaries](../guides/invoke-host-binaries.md). \ No newline at end of file +Learn how to [invoke host binaries](../guides/invoke-host-binaries.md). diff --git a/content/extensions/extensions-sdk/architecture/security.md b/content/extensions/extensions-sdk/architecture/security.md index 09c95f003a..14d16167f0 100644 --- a/content/extensions/extensions-sdk/architecture/security.md +++ b/content/extensions/extensions-sdk/architecture/security.md @@ -18,7 +18,6 @@ Extensions are executed with the same permissions as the Docker Desktop user. Ex The Extensions SDK provides a set of JavaScript APIs to invoke commands or invoke these binaries from the extension UI code. Extensions can also provide a backend part that starts a long-lived running container in the background. -> **Important** +> [!IMPORTANT] > > Make sure you trust the publisher or author of the extension when you install it, as the extension has the same access rights as the user running Docker Desktop. -{ .important } \ No newline at end of file diff --git a/content/extensions/extensions-sdk/build/backend-extension-tutorial.md b/content/extensions/extensions-sdk/build/backend-extension-tutorial.md index 0ca54cda48..ed87b1d297 100644 --- a/content/extensions/extensions-sdk/build/backend-extension-tutorial.md +++ b/content/extensions/extensions-sdk/build/backend-extension-tutorial.md @@ -16,7 +16,6 @@ Before you start, make sure you have installed the latest version of [Docker Des > Tip > > Check the [Quickstart guide](../quickstart.md) and `docker extension init `. They provide a better base for your extension as it's more up-to-date and related to your install of Docker Desktop. -{ .tip } ## Why add a backend? @@ -55,11 +54,10 @@ Here is the extension folder structure with a backend: Although you can start from an empty directory or from the `vm-ui extension` [sample](https://github.com/docker/extensions-sdk/tree/main/samples), it is highly recommended that you start from the `docker extension init` command and change it to suit your needs. -> **Tip** +> [!TIP] > > The `docker extension init` generates a Go backend. But you can still use it as a starting point for > your own extension and use any other language like Node.js, Python, Java, .Net, or any other language and framework. -{ .tip } In this tutorial, the backend service simply exposes one route that returns a JSON payload that says "Hello". @@ -67,14 +65,13 @@ In this tutorial, the backend service simply exposes one route that returns a JS { "Message": "Hello" } ``` -> **Important** +> [!IMPORTANT] > > We recommend that, the frontend and the backend communicate through sockets, and named pipes on Windows, instead of > HTTP. This prevents port collision with any other running application or container running > on the host. Also, some Docker Desktop users are running in constrained environments where they > can't open ports on their machines. When choosing the language and framework for your backend, make sure it > supports sockets connection. -{ .important } {{< tabs group="lang" >}} {{< tab name="Go" >}} @@ -133,45 +130,41 @@ type HTTPMessageBody struct { {{< /tab >}} {{< tab name="Node" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working example for Node yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=Node) > and let us know if you'd like a sample for Node. -{ .important } {{< /tab >}} {{< tab name="Python" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working example for Python yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=Python) > and let us know if you'd like a sample for Python. -{ .important } {{< /tab >}} {{< tab name="Java" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working example for Java yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=Java) > and let us know if you'd like a sample for Java. -{ .important } {{< /tab >}} {{< tab name=".NET" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working example for .NET. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=.Net) > and let us know if you'd like a sample for .NET. -{ .important } {{< /tab >}} {{< /tabs >}} ## Adapt the Dockerfile -> **Note** +> [!NOTE] > > When using the `docker extension init`, it creates a `Dockerfile` that already contains what is needed for a Go backend. @@ -183,11 +176,10 @@ To deploy your Go backend when installing the extension, you need first to confi - Copies the binary in the extension's container filesystem - Starts the binary when the container starts listening on the extension socket -> **Tip** +> [!TIP] > > To ease version management, you can reuse the same image to build the frontend, build the backend service, and package the extension. -{ .tip } ```dockerfile # syntax=docker/dockerfile:1 @@ -217,38 +209,34 @@ CMD /service -socket /run/guest-services/extension-allthethings-extension.sock {{< /tab >}} {{< tab name="Node" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for Node yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=Node) > and let us know if you'd like a Dockerfile for Node. -{ .important } {{< /tab >}} {{< tab name="Python" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for Python yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=Python) > and let us know if you'd like a Dockerfile for Python. -{ .important } {{< /tab >}} {{< tab name="Java" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for Java yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=Java) > and let us know if you'd like a Dockerfile for Java. -{ .important } {{< /tab >}} {{< tab name=".NET" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for .Net. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.25798127=.Net) > and let us know if you'd like a Dockerfile for .Net. -{ .important } {{< /tab >}} {{< /tabs >}} @@ -272,10 +260,9 @@ in the `vm` section of the `metadata.json` file. For more information on the `vm` section of the `metadata.json`, see [Metadata](../architecture/metadata.md). -> **Warning** +> [!WARNING] > > Do not replace the `${DESKTOP_PLUGIN_IMAGE}` placeholder in the `metadata.json` file. The placeholder is replaced automatically with the correct image name when the extension is installed. -{ .warning } ## Invoke the extension backend from your frontend @@ -320,29 +307,26 @@ export function App() { {{< /tab >}} {{< tab name="Vue" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Vue yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Vue) > and let us know if you'd like a sample with Vue. -{ .important } {{< /tab >}} {{< tab name="Angular" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Angular yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Angular) > and let us know if you'd like a sample with Angular. -{ .important } {{< /tab >}} {{< tab name="Svelte" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Svelte yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Svelte) > and let us know if you'd like a sample with Svelte. -{ .important } {{< /tab >}} {{< /tabs >}} @@ -363,11 +347,10 @@ docker extension update awesome-inc/my-extension:latest Now you can see the backend service running in the **Containers8* tab of the Docker Dashboard and watch the logs when you need to debug it. -> **Tip** +> [!TIP] > > You may need to turn on the **Show system containers** option in **Settings** to see the backend container running. > See [Show extension containers](../dev/test-debug.md#show-the-extension-containers) for more information. -{ .tip } Open Docker Dashboard and select the **Containers** tab. You should see the response from the backend service call displayed. @@ -375,4 +358,4 @@ call displayed. ## What's next? - Learn how to [share and publish your extension](../extensions/index.md). -- Learn more about extensions [architecture](../architecture/index.md). \ No newline at end of file +- Learn more about extensions [architecture](../architecture/index.md). diff --git a/content/extensions/extensions-sdk/build/frontend-extension-tutorial.md b/content/extensions/extensions-sdk/build/frontend-extension-tutorial.md index f2a979de2a..6a24f395d5 100644 --- a/content/extensions/extensions-sdk/build/frontend-extension-tutorial.md +++ b/content/extensions/extensions-sdk/build/frontend-extension-tutorial.md @@ -19,12 +19,11 @@ Before you start, make sure you have installed the latest version of [Docker Des The quickest way to create a new extension is to run `docker extension init my-extension` as in the [Quickstart](../quickstart.md). This creates a new directory `my-extension` that contains a fully functional extension. -> **Tip** +> [!TIP] > > The `docker extension init` generates a React based extension. But you can still use it as a starting point for > your own extension and use any other frontend framework, like Vue, Angular, Svelte, etc. or even stay with > vanilla Javascript. -{ .tip } Although you can start from an empty directory or from the `react-extension` [sample folder](https://github.com/docker/extensions-sdk/tree/main/samples), it's highly recommended that you start from the `docker extension init` command and change it to suit your needs. @@ -54,7 +53,7 @@ it's highly recommended that you start from the `docker extension init` command ## Adapting the Dockerfile -> **Note** +> [!NOTE] > > When using the `docker extension init`, it creates a `Dockerfile` that already contains what is needed for a React > extension. @@ -104,29 +103,26 @@ COPY --from=client-builder /ui/build ui {{< /tab >}} {{< tab name="Vue" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for Vue yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Vue) > and let us know if you'd like a Dockerfile for Vue. -{ .important } {{< /tab >}} {{< tab name="Angular" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for Angular yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Angular) > and let us know if you'd like a Dockerfile for Angular. -{ .important } {{< /tab >}} {{< tab name="Svelte" >}} -> **Important** +> [!IMPORTANT] > > We don't have a working Dockerfile for Svelte yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Svelte) > and let us know if you'd like a Dockerfile for Svelte. -{ .important } {{< /tab >}} {{< /tabs >}} @@ -290,29 +286,26 @@ export function App() { {{< /tab >}} {{< tab name="Vue" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Vue yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Vue) > and let us know if you'd like a sample with Vue. -{ .important } {{< /tab >}} {{< tab name="Angular" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Angular yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Angular) > and let us know if you'd like a sample with Angular. -{ .important } {{< /tab >}} {{< tab name="Svelte" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Svelte yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Svelte) > and let us know if you'd like a sample with Svelte. -{ .important } {{< /tab >}} {{< /tabs >}} @@ -349,11 +342,10 @@ $ docker extension update awesome-inc/my-extension:latest Now you can see the backend service running in the containers tab of the Docker Desktop Dashboard and watch the logs when you need to debug it. -> **Tip** +> [!TIP] > > You can turn on [hot reloading](../dev/test-debug.md#hot-reloading-whilst-developing-the-ui) to avoid the need to > rebuild the extension every time you make a change. -{ .tip } ## What's next? diff --git a/content/extensions/extensions-sdk/build/minimal-frontend-extension.md b/content/extensions/extensions-sdk/build/minimal-frontend-extension.md index 867a537976..f867477531 100644 --- a/content/extensions/extensions-sdk/build/minimal-frontend-extension.md +++ b/content/extensions/extensions-sdk/build/minimal-frontend-extension.md @@ -15,7 +15,6 @@ Before you start, make sure you have installed the latest version of [Docker Des > Tip > > If you want to start a codebase for your new extension, our [Quickstart guide](../quickstart.md) and `docker extension init ` provides a better base for your extension. -{ .tip } ## Extension folder structure @@ -106,4 +105,4 @@ The left-hand menu displays a new tab with the name of your extension. - Build a more [advanced frontend](frontend-extension-tutorial.md) extension. - Learn how to [test and debug](../dev/test-debug.md) your extension. - Learn how to [setup CI for your extension](../dev/continuous-integration.md). -- Learn more about extensions [architecture](../architecture/index.md). \ No newline at end of file +- Learn more about extensions [architecture](../architecture/index.md). diff --git a/content/extensions/extensions-sdk/design/_index.md b/content/extensions/extensions-sdk/design/_index.md index 55a6bdfa10..0195cb923d 100644 --- a/content/extensions/extensions-sdk/design/_index.md +++ b/content/extensions/extensions-sdk/design/_index.md @@ -50,4 +50,4 @@ Our colors have been chosen so that the counterpart colors in each variant of th ## What's next? - Take a look at our [MUI best practices](mui-best-practices.md). -- Learn how to [publish your extension](../extensions/index.md). \ No newline at end of file +- Learn how to [publish your extension](../extensions/index.md). diff --git a/content/extensions/extensions-sdk/design/design-principles.md b/content/extensions/extensions-sdk/design/design-principles.md index a193478664..b7206e8355 100644 --- a/content/extensions/extensions-sdk/design/design-principles.md +++ b/content/extensions/extensions-sdk/design/design-principles.md @@ -29,4 +29,4 @@ Our products focus on inclusive growth and are continuously useful and adapt to ## What's next? - Take a look at our [UI styling guidelines](index.md). -- Learn how to [publish your extension](../extensions/index.md). \ No newline at end of file +- Learn how to [publish your extension](../extensions/index.md). diff --git a/content/extensions/extensions-sdk/dev/api/backend.md b/content/extensions/extensions-sdk/dev/api/backend.md index 0064d21c09..df8ab51c63 100644 --- a/content/extensions/extensions-sdk/dev/api/backend.md +++ b/content/extensions/extensions-sdk/dev/api/backend.md @@ -173,8 +173,8 @@ window.ddClient.spawnHostCmd( ); ``` -> **Note** +> [!NOTE] > >You cannot use this to chain commands in a single `exec()` invocation (like `cmd1 $(cmd2)` or using pipe between commands). > -> You need to invoke `exec()` for each command and parse results to pass parameters to the next command if needed. \ No newline at end of file +> You need to invoke `exec()` for each command and parse results to pass parameters to the next command if needed. diff --git a/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md b/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md index 8e0bfb6a28..a9db1122ac 100644 --- a/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md +++ b/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md @@ -55,4 +55,4 @@ window.ddClient.navigateToVolumes(); window.ddClient.navigateToVolume(volume); window.ddClient.navigateToDevEnvironments(); -``` \ No newline at end of file +``` diff --git a/content/extensions/extensions-sdk/dev/api/dashboard.md b/content/extensions/extensions-sdk/dev/api/dashboard.md index 311c41f62c..1b5bc34dfd 100644 --- a/content/extensions/extensions-sdk/dev/api/dashboard.md +++ b/content/extensions/extensions-sdk/dev/api/dashboard.md @@ -94,4 +94,4 @@ window.ddClient.openExternal("https://docker.com"); ## Navigation to Dashboard routes -From your extension, you can also [navigate](dashboard-routes-navigation.md) to other parts of the Docker Desktop Dashboard. \ No newline at end of file +From your extension, you can also [navigate](dashboard-routes-navigation.md) to other parts of the Docker Desktop Dashboard. diff --git a/content/extensions/extensions-sdk/dev/api/docker.md b/content/extensions/extensions-sdk/dev/api/docker.md index 8e913f0d59..11c1129cb3 100644 --- a/content/extensions/extensions-sdk/dev/api/docker.md +++ b/content/extensions/extensions-sdk/dev/api/docker.md @@ -130,7 +130,7 @@ await ddClient.docker.cli.exec( ); ``` -> **Note** +> [!NOTE] > >You cannot use this to chain commands in a single `exec()` invocation (like `docker kill $(docker ps -q)` or using pipe between commands). > @@ -152,4 +152,4 @@ const output = await window.ddClient.execDockerCmd( window.ddClient.spawnDockerCmd("logs", ["-f", "..."], (data, error) => { console.log(data.stdout); }); -``` \ No newline at end of file +``` diff --git a/content/extensions/extensions-sdk/dev/api/overview.md b/content/extensions/extensions-sdk/dev/api/overview.md index f05db2ff9b..394bc016d0 100644 --- a/content/extensions/extensions-sdk/dev/api/overview.md +++ b/content/extensions/extensions-sdk/dev/api/overview.md @@ -34,4 +34,4 @@ The `ddClient` object gives access to various APIs: - [Dashboard](dashboard.md) - [Navigation](dashboard-routes-navigation.md) -Find the Extensions API reference [here](reference/README.md). \ No newline at end of file +Find the Extensions API reference [here](reference/README.md). diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md index d3da24c696..cb61c8a757 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md @@ -21,10 +21,9 @@ const output = await window.ddClient.backend.execInContainer(container, cmd); console.log(output); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. -{ .warning } #### Parameters @@ -53,10 +52,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [get](HttpService.md#get) instead. -{ .warning } #### Parameters @@ -82,10 +80,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [post](HttpService.md#post) instead. -{ .warning } #### Parameters @@ -112,10 +109,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [put](HttpService.md#put) instead. -{ .warning } #### Parameters @@ -142,10 +138,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [patch](HttpService.md#patch) instead. -{ .warning } #### Parameters @@ -172,10 +167,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [delete](HttpService.md#delete) instead. -{ .warning } #### Parameters @@ -201,10 +195,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [head](HttpService.md#head) instead. -{ .warning } #### Parameters @@ -230,10 +223,9 @@ window.ddClient.backend .then((value: any) => console.log(value)); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [request](HttpService.md#request) instead. -{ .warning } #### Parameters @@ -264,10 +256,9 @@ const output = await window.ddClient.backend.execInVMExtension( console.log(output); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. -{ .warning } #### Parameters @@ -301,10 +292,9 @@ window.ddClient.spawnInVMExtension( ); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. -{ .warning } #### Parameters diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md index 6e9423f33d..1189dc346d 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md @@ -24,7 +24,6 @@ The client is already connected to the backend. >**Warning** > > It will be removed in a future version. Use [extension](DockerDesktopClient.md#extension) instead. -{ .warning } #### Inherited from @@ -92,7 +91,6 @@ const containers = await window.ddClient.listContainers(); >**Warning** > > It will be removed in a future version. Use [listContainers](Docker.md#listcontainers) instead. -{ .warning } #### Parameters @@ -122,10 +120,9 @@ Get the list of images const images = await window.ddClient.listImages(); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [listImages](Docker.md#listimages) instead. -{ .warning } #### Parameters @@ -154,10 +151,9 @@ Navigate to the container's window in Docker Desktop. window.ddClient.navigateToContainers(); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [viewContainers](NavigationIntents.md#viewcontainers) instead. -{ .warning } #### Returns @@ -178,10 +174,9 @@ Navigate to the container window in Docker Desktop. await window.ddClient.navigateToContainer(id); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. -{ .warning } #### Parameters @@ -210,10 +205,9 @@ Navigate to the container logs window in Docker Desktop. await window.ddClient.navigateToContainerLogs(id); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. -{ .warning } #### Parameters @@ -242,10 +236,9 @@ Navigate to the container inspect window in Docker Desktop. await window.ddClient.navigateToContainerInspect(id); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. -{ .warning } #### Parameters @@ -275,10 +268,9 @@ Navigate to the container stats to see the CPU, memory, disk read/write and netw await window.ddClient.navigateToContainerStats(id); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. -{ .warning } #### Parameters @@ -307,10 +299,9 @@ Navigate to the images window in Docker Desktop. await window.ddClient.navigateToImages(id); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [viewImages](NavigationIntents.md#viewimages) instead. -{ .warning } #### Returns @@ -333,10 +324,9 @@ In this navigation route you can find the image layers, commands, created time a await window.ddClient.navigateToImage(id, tag); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [viewImage](NavigationIntents.md#viewimage) instead. -{ .warning } #### Parameters @@ -367,10 +357,9 @@ Navigate to the volumes window in Docker Desktop. await window.ddClient.navigateToVolumes(); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [viewVolumes](NavigationIntents.md#viewvolumes) instead. -{ .warning } #### Returns @@ -392,10 +381,9 @@ Navigate to a specific volume in Docker Desktop. window.ddClient.navigateToVolume(volume); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [viewVolume](NavigationIntents.md#viewvolume) instead. -{ .warning } #### Parameters @@ -423,10 +411,9 @@ Navigate to the Dev Environments window in Docker Desktop. window.ddClient.navigateToDevEnvironments(); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [viewDevEnvironments](NavigationIntents.md#viewdevenvironments) instead. -{ .warning } #### Returns @@ -452,10 +439,9 @@ window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => { }); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. -{ .warning } #### Parameters @@ -493,10 +479,9 @@ window.ddClient.spawnHostCmd( ); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. -{ .warning } #### Parameters @@ -526,10 +511,9 @@ You can also directly execute the Docker binary. const output = await window.ddClient.execDockerCmd("info"); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [exec](DockerCommand.md#exec) instead. -{ .warning } #### Parameters @@ -574,10 +558,9 @@ ___ ▸ **spawnDockerCmd**(`cmd`, `args`, `callback`): `void` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [exec](DockerCommand.md#exec) instead. -{ .warning } #### Parameters @@ -610,7 +593,6 @@ window.ddClient.openExternal("https://docker.com"); **Warning** > > It will be removed in a future version. Use [openExternal](Host.md#openexternal) instead. -{ .warning } #### Parameters @@ -643,7 +625,6 @@ window.ddClient.toastSuccess("message"); >**Warning`** > > It will be removed in a future version. Use [success](Toast.md#success) instead. -{ .warning } #### Parameters @@ -671,10 +652,9 @@ Display a toast message of type warning. window.ddClient.toastWarning("message"); ``` -> **Warning** +> [!WARNING] > > It will be removed in a future version. Use [warning](Toast.md#warning) instead. -{ .warning } #### Parameters @@ -705,7 +685,6 @@ window.ddClient.toastError("message"); >**Warning** > > It will be removed in a future version. Use [error](Toast.md#error) instead. -{ .warning } #### Parameters diff --git a/content/extensions/extensions-sdk/dev/continuous-integration.md b/content/extensions/extensions-sdk/dev/continuous-integration.md index f48d375150..d9acbce02d 100644 --- a/content/extensions/extensions-sdk/dev/continuous-integration.md +++ b/content/extensions/extensions-sdk/dev/continuous-integration.md @@ -8,10 +8,9 @@ aliases: In order to help validate your extension and ensure it's functional, the Extension SDK provides tools to help you setup continuous integration for your extension. -> **Important** +> [!IMPORTANT] > > The [Docker Desktop Action](https://github.com/docker/desktop-action) and the [extension-test-helper library](https://www.npmjs.com/package/@docker/extension-test-helper) are both [experimental](https://docs.docker.com/release-lifecycle/#experimental). -{ .important } ## Setup CI environment with GitHub Actions @@ -24,7 +23,7 @@ steps: uses: docker/desktop-action/start@v0.1.0 ``` -> **Note** +> [!NOTE] > > This action supports only Github Action macOS runners at the moment. You need to specify `runs-on: macOS-latest` for your end to end tests. @@ -83,4 +82,4 @@ afterAll(async () => { - Build an [advanced frontend](../build/frontend-extension-tutorial.md) extension. - Learn more about extensions [architecture](../architecture/index.md). -- Learn how to [publish your extension](../extensions/index.md). \ No newline at end of file +- Learn how to [publish your extension](../extensions/index.md). diff --git a/content/extensions/extensions-sdk/dev/test-debug.md b/content/extensions/extensions-sdk/dev/test-debug.md index eef806f035..dcfcf24286 100644 --- a/content/extensions/extensions-sdk/dev/test-debug.md +++ b/content/extensions/extensions-sdk/dev/test-debug.md @@ -75,4 +75,4 @@ $ docker extension rm - Learn more about extensions [architecture](../architecture/index.md). - Explore our [design principles](../design/design-principles.md). - Take a look at our [UI styling guidelines](../design/index.md). -- Learn how to [setup CI for your extension](continuous-integration.md). \ No newline at end of file +- Learn how to [setup CI for your extension](continuous-integration.md). diff --git a/content/extensions/extensions-sdk/extensions/DISTRIBUTION.md b/content/extensions/extensions-sdk/extensions/DISTRIBUTION.md index 0135afe393..fb1c5f1fe2 100644 --- a/content/extensions/extensions-sdk/extensions/DISTRIBUTION.md +++ b/content/extensions/extensions-sdk/extensions/DISTRIBUTION.md @@ -46,4 +46,4 @@ Extension image labels must specify the API version that the extension relies up The [Docker Extension SDK](https://www.npmjs.com/package/@docker/extension-api-client) is licensed under the Apache 2.0 License and is free to use. -There is no constraint on how each extension should be licensed, this is up to you to decide when creating a new extension. \ No newline at end of file +There is no constraint on how each extension should be licensed, this is up to you to decide when creating a new extension. diff --git a/content/extensions/extensions-sdk/extensions/_index.md b/content/extensions/extensions-sdk/extensions/_index.md index 0b3bc76ad9..9e5297688d 100644 --- a/content/extensions/extensions-sdk/extensions/_index.md +++ b/content/extensions/extensions-sdk/extensions/_index.md @@ -43,4 +43,4 @@ Extensions published in the Marketplace benefit from update notifications to all In addition to providing a description of your extension's features and screenshots, you should also specify additional URLs using [extension labels](labels.md). This direct users to your website for reporting bugs and feedback, and accessing documentation and support. -{{< include "extensions-form.md" >}} \ No newline at end of file +{{< include "extensions-form.md" >}} diff --git a/content/extensions/extensions-sdk/extensions/labels.md b/content/extensions/extensions-sdk/extensions/labels.md index eb7bcd6a33..a11d5d7ff7 100644 --- a/content/extensions/extensions-sdk/extensions/labels.md +++ b/content/extensions/extensions-sdk/extensions/labels.md @@ -14,10 +14,9 @@ This information is then displayed as an overview of the extension, so users can You can define [image labels](/reference/dockerfile.md#label) in the extension's `Dockerfile`. -> **Important** +> [!IMPORTANT] > > If any of the **required** labels are missing in the `Dockerfile`, Docker Desktop considers the extension invalid and doesn't list it in the Marketplace. -{ .important } Here is the list of labels you can or need to specify when building your extension: @@ -37,12 +36,11 @@ Here is the list of labels you can or need to specify when building your extensi | `com.docker.extension.account-info` | No | Whether the user needs to register to a SaaS platform to use some features of the extension. | `required` in case it does, leave it empty otherwise. | | `com.docker.extension.categories` | No | The list of Marketplace categories that your extension belongs to: `ci-cd`, `container-orchestration`, `cloud-deployment`, `cloud-development`, `database`, `kubernetes`, `networking`, `image-registry`, `security`, `testing-tools`, `utility-tools`,`volumes`. If you don't specify this label, users won't be able to find your extension in the Extensions Marketplace when filtering by a category. Extensions published to the Marketplace before the 22nd of September 2022 have been auto-categorized by Docker. | Specified as comma separated values in case of having multiple categories e.g: `kubernetes,security` or a single value e.g. `kubernetes`. | -> **Tip** +> [!TIP] > > Docker Desktop applies CSS styles to the provided HTML content. You can make sure that it renders correctly > [within the Marketplace](#preview-the-extension-in-the-marketplace). It is recommended that you follow the > [styling guidelines](../design/index.md). -{ .tip } ## Preview the extension in the Marketplace diff --git a/content/extensions/extensions-sdk/extensions/multi-arch.md b/content/extensions/extensions-sdk/extensions/multi-arch.md index 3bbaa41c00..00de640c7d 100644 --- a/content/extensions/extensions-sdk/extensions/multi-arch.md +++ b/content/extensions/extensions-sdk/extensions/multi-arch.md @@ -54,10 +54,9 @@ Manifests: Platform: linux/arm64 ``` -> **Tip** +> [!TIP] > > If you're having trouble pushing the image, make sure you're signed in to Docker Hub. Otherwise, run `docker login` to authenticate. -{ .tip } For more information, see [Multi-platform images](/build/building/multi-platform.md) page. @@ -135,7 +134,7 @@ As a result, when `TARGETARCH` equals: - `arm64`, the `kubectl` binary fetched corresponds to the `arm64` architecture, and is copied to `/darwin/kubectl` in the final stage. - `amd64`, two `kubectl` binaries are fetched. One for Darwin and another for Windows. They are copied to `/darwin/kubectl` and `/windows/kubectl.exe` respectively, in the final stage. -> **Note** +> [!NOTE] > > The binary destination path for Darwin is `darwin/kubectl` in both cases. The only change is the architecture-specific binary that is downloaded. diff --git a/content/extensions/extensions-sdk/extensions/publish.md b/content/extensions/extensions-sdk/extensions/publish.md index 63340be38d..64cadc6f39 100644 --- a/content/extensions/extensions-sdk/extensions/publish.md +++ b/content/extensions/extensions-sdk/extensions/publish.md @@ -13,15 +13,14 @@ The Extensions Marketplace is a space where developers can discover extensions t Whenever you are [ready to publish](DISTRIBUTION.md) your extension in the Marketplace, you can [self-publish your extension](https://github.com/docker/extensions-submissions/issues/new?assignees=&labels=&template=1_automatic_review.yaml&title=%5BSubmission%5D%3A+) -> **Note** +> [!NOTE] > > As the Extension Marketplace continues to add new features for both Extension users and publishers, you are expected > to maintain your extension over time to ensure it stays available in the Marketplace. -> **Important** +> [!IMPORTANT] > > The Docker manual review process for extensions is paused at the moment. Submit your extension through the [automated submission process](https://github.com/docker/extensions-submissions/issues/new?assignees=&labels=&template=1_automatic_review.yaml&title=%5BSubmission%5D%3A+) -{ .important } ### Before you submit @@ -47,8 +46,7 @@ published on the Marketplace and accessible to all users within a few hours. It is the fastest way to get developers the tools they need and to get feedback from them as you work to evolve/polish your extension. -> **Important** +> [!IMPORTANT] > > Docker Desktop caches the list of extensions available in the Marketplace for 12 hours. If you don't see your > extension in the Marketplace, you can restart Docker Desktop to force the cache to refresh. -{ .important } diff --git a/content/extensions/extensions-sdk/extensions/share.md b/content/extensions/extensions-sdk/extensions/share.md index 1dddc84ca4..78e8cd3512 100644 --- a/content/extensions/extensions-sdk/extensions/share.md +++ b/content/extensions/extensions-sdk/extensions/share.md @@ -32,6 +32,6 @@ To generate this link you can either: ![Share button](images/list-preview.png) -> **Note** +> [!NOTE] > -> Previews of the extension description or screenshots, for example, are created using [extension labels](labels.md). \ No newline at end of file +> Previews of the extension description or screenshots, for example, are created using [extension labels](labels.md). diff --git a/content/extensions/extensions-sdk/extensions/validate.md b/content/extensions/extensions-sdk/extensions/validate.md index d16c053e3b..1131d8794b 100644 --- a/content/extensions/extensions-sdk/extensions/validate.md +++ b/content/extensions/extensions-sdk/extensions/validate.md @@ -36,4 +36,4 @@ Before the image is built, it's also possible to validate only the `metadata.jso $ docker extension validate /path/to/metadata.json ``` -The JSON schema used to validate the `metadata.json` file against can be found under the [releases page](https://github.com/docker/extensions-sdk/releases/latest). \ No newline at end of file +The JSON schema used to validate the `metadata.json` file against can be found under the [releases page](https://github.com/docker/extensions-sdk/releases/latest). diff --git a/content/extensions/extensions-sdk/guides/invoke-host-binaries.md b/content/extensions/extensions-sdk/guides/invoke-host-binaries.md index b01822c64b..15673f44da 100644 --- a/content/extensions/extensions-sdk/guides/invoke-host-binaries.md +++ b/content/extensions/extensions-sdk/guides/invoke-host-binaries.md @@ -19,7 +19,7 @@ means that you need to ship the executables for all the platforms you want to su Learn more about extensions [architecture](../architecture/index.md). -> **Note** +> [!NOTE] > > Only executables shipped as part of the extension can be invoked with the SDK. @@ -100,29 +100,26 @@ export function App() { {{< /tab >}} {{< tab name="Vue" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Vue yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Vue) > and let us know if you'd like a sample with Vue. -{ .important } {{< /tab >}} {{< tab name="Angular" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Angular yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Angular) > and let us know if you'd like a sample with Angular. -{ .important } {{< /tab >}} {{< tab name="Svelte" >}} -> **Important** +> [!IMPORTANT] > > We don't have an example for Svelte yet. [Fill out the form](https://docs.google.com/forms/d/e/1FAIpQLSdxJDGFJl5oJ06rG7uqtw1rsSBZpUhv_s9HHtw80cytkh2X-Q/viewform?usp=pp_url&entry.1333218187=Svelte) > and let us know if you'd like a sample with Svelte. -{ .important } {{< /tab >}} {{< /tabs >}} @@ -164,4 +161,4 @@ the extension. Once the extension is uninstalled, the binaries that were copied } ``` -The `path` must reference the path of the binary inside the container. \ No newline at end of file +The `path` must reference the path of the binary inside the container. diff --git a/content/extensions/extensions-sdk/guides/kubernetes.md b/content/extensions/extensions-sdk/guides/kubernetes.md index e5f7e34414..db2d0670a8 100644 --- a/content/extensions/extensions-sdk/guides/kubernetes.md +++ b/content/extensions/extensions-sdk/guides/kubernetes.md @@ -77,7 +77,6 @@ Below there are different ways to persist and read the `kubeconfig` file from th > Warning > > The `kubeconfig` file is very sensitive and if found can give an attacker administrative access to the Kubernetes Cluster. -{ .warning } ### Extension's backend container @@ -150,4 +149,4 @@ localStorage.setItem("kubeconfig", kubeConfig); ```typescript localStorage.getItem("kubeconfig"); -``` \ No newline at end of file +``` diff --git a/content/extensions/extensions-sdk/guides/oauth2-flow.md b/content/extensions/extensions-sdk/guides/oauth2-flow.md index 37b4407423..78be177698 100644 --- a/content/extensions/extensions-sdk/guides/oauth2-flow.md +++ b/content/extensions/extensions-sdk/guides/oauth2-flow.md @@ -7,7 +7,7 @@ aliases: - /desktop/extensions-sdk/guides/oauth2-flow/ --- -> **Note** +> [!NOTE] > > This page assumes that you already have an Identity Provider (IdP), such as Google, Entra ID (formerly Azure AD) or Okta, which handles the authentication process and returns an access token. @@ -55,10 +55,9 @@ window.ddClient.openExternal("https://authorization-server.com/authorize? You can get the authorization code from the extension UI by listing `docker-desktop://dashboard/extension-tab?extensionId=awesome/my-extension` as the `redirect_uri` in the OAuth app you're using and concatenating the authorization code as a query parameter. The extension UI code will then be able to read the corresponding code query-param. -> **Important** +> [!IMPORTANT] > > Using this feature requires the extension SDK 0.3.3 in Docker Desktop. You need to ensure that the required SDK version for your extension set with `com.docker.desktop.extension.api.version` in [image labels](../extensions/labels.md) is higher than 0.3.3. -{ .important } #### Authorization @@ -78,7 +77,7 @@ POST https://authorization-server.com/token &code=N949tDLuf9ai_DaOKyuFBXStCNMQzuQbtC1QbvLv-AXqPJ_f ``` -> **Note** +> [!NOTE] > > The client's credentials are included in the `POST` query params in this example. OAuth authorization servers may require that the credentials are sent as a HTTP Basic Authentication header or might support different formats. See your OAuth provider docs for details. @@ -88,7 +87,7 @@ The Docker Extensions SDK doesn't provide a specific mechanism to store secrets. It's highly recommended that you use an external source of storage to store the access token. -> **Note** +> [!NOTE] > > The user interface Local Storage is isolated between extensions (an extension can't access another extension's local storage), and each extension's local storage gets deleted when users uninstall an extension. diff --git a/content/extensions/extensions-sdk/process.md b/content/extensions/extensions-sdk/process.md index 7806362e81..cb9ae82546 100644 --- a/content/extensions/extensions-sdk/process.md +++ b/content/extensions/extensions-sdk/process.md @@ -13,7 +13,7 @@ There are two main parts to creating a Docker extension: 1. Build the foundations 2. Publish the extension -> **Note** +> [!NOTE] > > You do not need to pay to create a Docker extension. The [Docker Extension SDK](https://www.npmjs.com/package/@docker/extension-api-client) is licensed under the Apache 2.0 License and is free to use. Anyone can create new extensions and share them without constraints. > @@ -31,10 +31,9 @@ The build process consists of: For further inspiration, see the other examples in the [samples folder](https://github.com/docker/extensions-sdk/tree/main/samples). -> **Tip** +> [!TIP] > > Whilst creating your extension, make sure you follow the [design](design/design-guidelines.md) and [UI styling](design/index.md) guidelines to ensure visual consistency and [level AA accessibility standards](https://www.w3.org/WAI/WCAG2AA-Conformance). -{ .tip } ## Part two: Publish and distribute your extension @@ -52,4 +51,4 @@ Alternatively, get started with reading the "Part one: Build" section for more i For an in-depth tutorial of the entire build process, we recommend the following video walkthrough from DockerCon 2022. - \ No newline at end of file + diff --git a/content/extensions/extensions-sdk/quickstart.md b/content/extensions/extensions-sdk/quickstart.md index c1e2d83343..51bbe54a2b 100644 --- a/content/extensions/extensions-sdk/quickstart.md +++ b/content/extensions/extensions-sdk/quickstart.md @@ -15,7 +15,7 @@ Follow this guide to get started with creating a basic Docker extension. The Qui - [NodeJS](https://nodejs.org/) - [Go](https://go.dev/dl/) -> **Note** +> [!NOTE] > > NodeJS and Go are only required when you follow the quickstart guide to create an extension. It uses the `docker extension init` command to automatically generate boilerplate files. This command uses a template based on a ReactJS and Go application. @@ -65,11 +65,10 @@ $ docker extension install To preview the extension in Docker Desktop, once the installation is complete and you should see a **Quickstart** item underneath the **Extensions** menu. Selecting this item opens the extension's frontend. -> **Tip** +> [!TIP] > > During UI development, it’s helpful to use hot reloading to test your changes without rebuilding your entire > extension. See [Preview whilst developing the UI](dev/test-debug.md#hot-reloading-whilst-developing-the-ui) for more information. -{ .tip } You may also want to inspect the containers that belong to the extension. By default, extension containers are hidden from the Docker Dashboard. You can change this in **Settings**, see diff --git a/content/extensions/marketplace.md b/content/extensions/marketplace.md index a85a1fee28..bc0ca343a9 100644 --- a/content/extensions/marketplace.md +++ b/content/extensions/marketplace.md @@ -17,7 +17,7 @@ Self-published extensions are autonomously published by extension developers and ## Install an extension -> **Note** +> [!NOTE] > > For some extensions, a separate account needs to be created before use. @@ -43,7 +43,7 @@ The **Manage** tab displays with all your installed extensions. If an extension You can uninstall an extension at any time. -> **Note** +> [!NOTE] > > Any data used by the extension that's stored in a volume must be manually deleted. diff --git a/content/extensions/non-marketplace.md b/content/extensions/non-marketplace.md index d5434d87e2..eb3825f2ec 100644 --- a/content/extensions/non-marketplace.md +++ b/content/extensions/non-marketplace.md @@ -8,18 +8,17 @@ aliases: ## Install an extension not available in the Marketplace -> **Warning** +> [!WARNING] > > Docker Extensions that are not in the Marketplace haven't gone through Docker's review process. > Extensions can install binaries, invoke commands and access files on your machine. Installing them is at your own risk. -{ .warning } The Extensions Marketplace is the trusted and official place to install extensions from within Docker Desktop. These extensions have gone through a review process by Docker. However, other extensions can also be installed in Docker Desktop if you trust the extension author. Given the nature of a Docker Extension (i.e. a Docker image) you can find other places where users have their extension's source code published. For example on GitHub, GitLab or even hosted in image registries like DockerHub or GHCR. You can install an extension that has been developed by the community or internally at your company from a teammate. You are not limited to installing extensions just from the Marketplace. -> **Note** +> [!NOTE] > > Ensure the option **Allow only extensions distributed through the Docker Marketplace** is disabled. Otherwise, this prevents any extension not listed in the Marketplace, via the Extension SDK tools from, being installed. > You can change this option in **Settings**. @@ -51,7 +50,7 @@ To update an extension which isn't present in the Marketplace, in a terminal typ For instance, if you installed an extension with `docker extension install john/my-extension:0.0.1`, you can update it by running `docker extension update john/my-extension:0.0.2`. Go to the Docker Dashboard to see the new extension updated. -> **Note** +> [!NOTE] > > Extensions that aren't installed through the Marketplace don't receive update notifications from Docker Desktop. diff --git a/content/extensions/private-marketplace.md b/content/extensions/private-marketplace.md index a6244e854a..e7a30a6bae 100644 --- a/content/extensions/private-marketplace.md +++ b/content/extensions/private-marketplace.md @@ -104,10 +104,9 @@ This list can include different types of extension images: - Extension images stored in Docker Hub as private images. Developers need to be signed in and have pull access to these images. - Extension images stored in a private registry. Developers need to be signed in and have pull access to these images. -> **Important** +> [!IMPORTANT] > > Your developers can only install the version of the extension that you’ve listed. -{ .important} ## Step four: Generate the private marketplace @@ -200,4 +199,4 @@ Make sure your developers are signed in to Docker Desktop in order for the priva ## Feedback -Give feedback or report any bugs you may find by emailing `extensions@docker.com`. \ No newline at end of file +Give feedback or report any bugs you may find by emailing `extensions@docker.com`. diff --git a/content/extensions/settings-feedback.md b/content/extensions/settings-feedback.md index 66ca7136f5..2e82fd1c46 100644 --- a/content/extensions/settings-feedback.md +++ b/content/extensions/settings-feedback.md @@ -45,7 +45,7 @@ update your settings: 3. Next to **Show Docker Extensions system containers**, select or clear the checkbox to set your desired state. 4. In the bottom-right corner, select **Apply & Restart**. -> **Note** +> [!NOTE] > > Enabling extensions doesn't use computer resources (CPU / Memory) by itself. > @@ -64,4 +64,4 @@ extension, select: - Slack - Issues. You'll be sent to a page outside of Docker Desktop to submit your feedback. -If an extension doesn't provide a way for you to give feedback, contact us and we'll pass on the feedback for you. To provide feedback, select the **Give feedback** to the right of **Extensions Marketplace**. \ No newline at end of file +If an extension doesn't provide a way for you to give feedback, contact us and we'll pass on the feedback for you. To provide feedback, select the **Give feedback** to the right of **Extensions Marketplace**. diff --git a/content/get-docker.md b/content/get-docker.md index 7f171f48b2..974bb23449 100644 --- a/content/get-docker.md +++ b/content/get-docker.md @@ -51,6 +51,6 @@ section and choose the best installation path for you. link="/desktop/install/linux-install/" icon="/assets/images/linux_48.svg" >}} -> **Note** +> [!NOTE] > > If you're looking for information on how to install Docker Engine, see [Docker Engine installation overview](/engine/install/). diff --git a/content/guides/deployment-orchestration/kube-deploy.md b/content/guides/deployment-orchestration/kube-deploy.md index 94f8dbd864..527a186303 100644 --- a/content/guides/deployment-orchestration/kube-deploy.md +++ b/content/guides/deployment-orchestration/kube-deploy.md @@ -131,4 +131,4 @@ Further documentation for all new Kubernetes objects used in this article are av - [Kubernetes Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod/) - [Kubernetes Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) - - [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/) \ No newline at end of file + - [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/) diff --git a/content/guides/deployment-orchestration/orchestration.md b/content/guides/deployment-orchestration/orchestration.md index 817b84ae55..c44353f22e 100644 --- a/content/guides/deployment-orchestration/orchestration.md +++ b/content/guides/deployment-orchestration/orchestration.md @@ -314,4 +314,4 @@ Further documentation for all CLI commands used in this article are available he - [`kubectl logs`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#logs) - [`kubectl delete`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#delete) - [`docker swarm init`](/reference/cli/docker/swarm/init/) -- [`docker service *`](/reference/cli/docker/service/) \ No newline at end of file +- [`docker service *`](/reference/cli/docker/service/) diff --git a/content/guides/deployment-orchestration/swarm-deploy.md b/content/guides/deployment-orchestration/swarm-deploy.md index 914827ecde..42acdf19a0 100644 --- a/content/guides/deployment-orchestration/swarm-deploy.md +++ b/content/guides/deployment-orchestration/swarm-deploy.md @@ -107,4 +107,4 @@ Further documentation for all new Swarm objects and CLI commands used in this ar - [Swarm Mode Services](../../engine/swarm/how-swarm-mode-works/services.md) - [Swarm Stacks](../../engine/swarm/stack-deploy.md) - [`docker stack *`](/reference/cli/docker/stack/) - - [`docker service *`](/reference/cli/docker/service/) \ No newline at end of file + - [`docker service *`](/reference/cli/docker/service/) diff --git a/content/guides/docker-concepts/building-images/multi-stage-builds.md b/content/guides/docker-concepts/building-images/multi-stage-builds.md index ad92bde248..65f3d49543 100644 --- a/content/guides/docker-concepts/building-images/multi-stage-builds.md +++ b/content/guides/docker-concepts/building-images/multi-stage-builds.md @@ -282,7 +282,6 @@ Now that you have the project, you’re ready to create the `Dockerfile`. > For production use, it's highly recommended that you produce a custom JRE-like runtime using jlink. JRE images are available for all versions of Eclipse Temurin, but `jlink` allows you to create a minimal runtime containing only the necessary Java modules for your application. This can significantly reduce the size and improve the security of your final image. [Refer to this page](https://hub.docker.com/_/eclipse-temurin) for more information. - { .tip } With multi-stage builds, a Docker build uses one base image for compilation, packaging, and unit tests and then a separate image for the application runtime. As a result, the final image is smaller in size since it doesn’t contain any development or debugging tools. By separating the build environment from the final runtime environment, you can significantly reduce the image size and increase the security of your final images. @@ -296,7 +295,7 @@ Now that you have the project, you’re ready to create the `Dockerfile`. This command builds a Docker image named `spring-helloworld-builder` using the final stage from your `Dockerfile` file located in the current directory. - > **Note** + > [!NOTE] > > In your multi-stage Dockerfile, the final stage (final) is the default target for building. This means that if you don't explicitly specify a target stage using the `--target` flag in the `docker build` command, Docker will automatically build the last stage by default. You could use `docker build -t spring-helloworld-builder --target builder .` to build only the builder stage with the JDK environment. diff --git a/content/guides/docker-concepts/building-images/understanding-image-layers.md b/content/guides/docker-concepts/building-images/understanding-image-layers.md index 0693a57785..de822b1e5e 100644 --- a/content/guides/docker-concepts/building-images/understanding-image-layers.md +++ b/content/guides/docker-concepts/building-images/understanding-image-layers.md @@ -125,7 +125,6 @@ In this first step, you will create your own base image that you will then use f > A base image is a foundation for building other images. It's possible to use any images as a base image. However, some images are intentionally created as building blocks, providing a foundation or starting point for an application. > > In this example, you probably won’t deploy this `node-base` image, as it doesn’t actually do anything yet. But it’s a base you can use for other builds. -{ .tip } ### Build an app image diff --git a/content/guides/docker-concepts/building-images/writing-a-dockerfile.md b/content/guides/docker-concepts/building-images/writing-a-dockerfile.md index 1fe6451822..b914951225 100644 --- a/content/guides/docker-concepts/building-images/writing-a-dockerfile.md +++ b/content/guides/docker-concepts/building-images/writing-a-dockerfile.md @@ -74,7 +74,6 @@ Now that you have the project, you’re ready to create the `Dockerfile`. > > It's important to note that the `Dockerfile` has _no_ file extension. Some editors > will automatically add an extension to the file (or complain it doesn't have one). - { .important } 3. In the `Dockerfile`, define your base image by adding the following line: @@ -124,7 +123,6 @@ Now that you have the project, you’re ready to create the `Dockerfile`. > > Keep reading to learn more about how to make the image maximize the > build cache, run as a non-root user, and multi-stage builds. -{ .important } > **Containerize new projects quickly with `docker init`** @@ -133,7 +131,6 @@ Now that you have the project, you’re ready to create the `Dockerfile`. > a Dockerfile, a `compose.yaml`, and a `.dockerignore`, helping you get > up and going. Since you're learning about Dockerfiles specifically here, > you won't use it now. But, [learn more about it here](/engine/reference/commandline/init/). -{ .tip } ## Additional resources diff --git a/content/guides/docker-concepts/running-containers/multi-container-applications.md b/content/guides/docker-concepts/running-containers/multi-container-applications.md index 2ca21c5ed9..66a30defbb 100644 --- a/content/guides/docker-concepts/running-containers/multi-container-applications.md +++ b/content/guides/docker-concepts/running-containers/multi-container-applications.md @@ -133,7 +133,7 @@ In this hands-on guide, you'll first see how to build and run a counter web appl $ docker run -d --name nginx --network sample-app -p 80:80 nginx ``` - > **Note** + > [!NOTE] > > Nginx is typically used as a reverse proxy for web applications, routing traffic to backend servers. In this case, it routes to the Node.js backend containers (web1 or web2). @@ -167,7 +167,7 @@ In this hands-on guide, you'll first see how to build and run a counter web appl web1: Number of visits is: 12 ``` - > **Note** + > [!NOTE] > > You might have noticed that Nginx, acting as a reverse proxy, likely distributes incoming requests in a round-robin fashion between the two backend containers. This means each request might be directed to a different container (web1 and web2) on a rotating basis. The output shows consecutive increments for both the web1 and web2 containers and the actual counter value stored in Redis is updated only after the response is sent back to the client. diff --git a/content/guides/docker-concepts/running-containers/overriding-container-defaults.md b/content/guides/docker-concepts/running-containers/overriding-container-defaults.md index a4d996b3f7..54448baf3b 100644 --- a/content/guides/docker-concepts/running-containers/overriding-container-defaults.md +++ b/content/guides/docker-concepts/running-containers/overriding-container-defaults.md @@ -39,13 +39,12 @@ HOSTNAME=2042f2e6ebe4 foo=bar ``` -> **Tip** +> [!TIP] > > The `.env` file acts as a convenient way to set environment variables for your Docker containers without cluttering your command line with numerous `-e` flags. To use a `.env` file, you can pass `--env-file` option with the `docker run` command. > ```console > $ docker run --env-file .env postgres env > ``` -{ .tip } ### Restricting the container to consume the resources @@ -60,7 +59,6 @@ This command limits container memory usage to 512 MB and defines the CPU quota o > **Monitor the real-time resource usage** > > You can use the `docker stats` command to monitor the real-time resource usage of running containers. This helps you understand whether the allocated resources are sufficient or need adjustment. -{ .tip } By effectively using these `docker run` flags, you can tailor your containerized application's behavior to fit your specific requirements. @@ -127,7 +125,6 @@ Follow the steps to see how to connect a Postgres container to a custom network. > > 1. DNS resolution: By default, containers connected to the default bridge network can communicate with each other, but only by IP address. (unless you use `--link` option which is considered legacy). It is not recommended for production use due to the various [technical shortcomings](/engine/network/drivers/bridge/#differences-between-user-defined-bridges-and-the-default-bridge). On a custom network, containers can resolve each other by name or alias. > 2. Isolation: All containers without a `--network` specified are attached to the default bridge network, hence can be a risk, as unrelated containers are then able to communicate. Using a custom network provides a scoped network in which only containers attached to that network are able to communicate, hence providing better isolation. - { .tip } ### Manage the resources @@ -181,7 +178,7 @@ Sometimes, you might need to override the default commands (`CMD`) or entry poin ![A screenshot of the Docker Dashboard selecting the Postgres container and entering into its shell using EXEC button](images/exec-into-postgres-container.webp?border=true) - > **Note** + > [!NOTE] > > The PostgreSQL image sets up trust authentication locally so you may notice a password isn't required when connecting from localhost (inside the same container). However, a password will be required if connecting from a different host/container. diff --git a/content/guides/docker-concepts/running-containers/persisting-container-data.md b/content/guides/docker-concepts/running-containers/persisting-container-data.md index 20c79bc3f0..80df123163 100644 --- a/content/guides/docker-concepts/running-containers/persisting-container-data.md +++ b/content/guides/docker-concepts/running-containers/persisting-container-data.md @@ -37,7 +37,6 @@ When the container runs, all files it writes into the `/logs` folder will be sav > **Sharing files using volumes** > > You can attach the same volume to multiple containers to share files between containers. This might be helpful in scenarios such as log aggregation, data pipelines, or other event-driven applications. -{ .tip } ### Managing volumes diff --git a/content/guides/docker-concepts/running-containers/publishing-ports.md b/content/guides/docker-concepts/running-containers/publishing-ports.md index 03e45e88d6..6b488d584d 100644 --- a/content/guides/docker-concepts/running-containers/publishing-ports.md +++ b/content/guides/docker-concepts/running-containers/publishing-ports.md @@ -31,10 +31,9 @@ $ docker run -d -p 8080:80 nginx Now, any traffic sent to port `8080` on your host machine will be forwarded to port `80` within the container. -> **Important** +> [!IMPORTANT] > > When a port is published, it's published to all network interfaces by default. This means any traffic that reaches your machine can access the published application. Be mindful of publishing databases or any sensitive information. [Learn more about published ports here](/engine/network/#published-ports). -{ .important } ### Publishing to ephemeral ports diff --git a/content/guides/docker-concepts/running-containers/sharing-local-files.md b/content/guides/docker-concepts/running-containers/sharing-local-files.md index 466dbe6de5..9e2d4561cb 100644 --- a/content/guides/docker-concepts/running-containers/sharing-local-files.md +++ b/content/guides/docker-concepts/running-containers/sharing-local-files.md @@ -41,7 +41,7 @@ The `--mount` flag offers more advanced features and granular control, making it $ docker run --mount type=bind,source=/HOST/PATH,target=/CONTAINER/PATH,readonly nginx ``` -> **Note** +> [!NOTE] > > Docker recommends using the `--mount` syntax instead of `-v`. It provides better control over the mounting process and avoids potential issues with missing directories. @@ -59,7 +59,6 @@ Read-only bind mounts let the container access the mounted files on the host for > **Synchronised File Share** > > As your codebase grows larger, traditional methods of file sharing like bind mounts may become inefficient or slow, especially in development environments where frequent access to files is necessary. [Synchronized file shares](/desktop/synchronized-file-sharing/) improve bind mount performance by leveraging synchronized filesystem caches. This optimization ensures that file access between the host and virtual machine (VM) is fast and efficient. -{ .tip } ## Try it out @@ -147,9 +146,8 @@ Using a bind mount, you can map the configuration file on your host computer to {{< /tabs >}} - > **Tip** + > [!TIP] > When using the `-v` or `--mount` flag in Windows PowerShell, you need to provide the absolute path to your directory instead of just `./`. This is because PowerShell handles relative paths differently from bash (commonly used in Mac and Linux environments). - { .tip } diff --git a/content/guides/docker-concepts/the-basics/what-is-a-container.md b/content/guides/docker-concepts/the-basics/what-is-a-container.md index 13b3d07a65..1d0436bdee 100644 --- a/content/guides/docker-concepts/the-basics/what-is-a-container.md +++ b/content/guides/docker-concepts/the-basics/what-is-a-container.md @@ -142,10 +142,9 @@ You will see output like the following: This container runs a web server that displays a simple website. When working with more complex projects, you'll run different parts in different containers. For example, a different container for the `frontend`, `backend`, and `database`. -> **Tip** +> [!TIP] > > The `docker ps` command will show you _only_ running containers. To view stopped containers, add the `-a` flag to list all containers: `docker ps -a` -{ .tip } ### Access the frontend @@ -168,14 +167,13 @@ The `docker/welcome-to-docker` container continues to run until you stop it. You docker stop ``` -> **Tip** +> [!TIP] > > When referencing containers by ID, you don't need to provide the full ID. You only need to provide enough of the ID to make it unique. As an example, the previous container could be stopped by running the following command: > > ```console > docker stop a1f > ``` -{ .tip } {{< /tab >}} {{< /tabs >}} diff --git a/content/guides/docker-concepts/the-basics/what-is-an-image.md b/content/guides/docker-concepts/the-basics/what-is-an-image.md index f37eb0f752..536ac4b6a2 100644 --- a/content/guides/docker-concepts/the-basics/what-is-an-image.md +++ b/content/guides/docker-concepts/the-basics/what-is-an-image.md @@ -180,7 +180,6 @@ Follow the instructions to search and pull a Docker image using CLI to view its > **Viewing the full command** > > If you add the `--no-trunc` flag to the command, you will see the full command. Note that, since the output is in a table-like format, longer commands will cause the output to be very difficult to navigate. - { .tip } {{< /tab >}} diff --git a/content/guides/docker-concepts/the-basics/what-is-docker-compose.md b/content/guides/docker-concepts/the-basics/what-is-docker-compose.md index 85f55520af..841ac8d242 100644 --- a/content/guides/docker-concepts/the-basics/what-is-docker-compose.md +++ b/content/guides/docker-concepts/the-basics/what-is-docker-compose.md @@ -115,7 +115,6 @@ Since this application was started using Docker Compose, it's easy to tear it al > ```console > docker compose down --volumes > ``` - { .tip } 2. Alternatively, you can use the Docker Desktop GUI to remove the containers by selecting the application stack and selecting the **Delete** button. @@ -124,7 +123,6 @@ Since this application was started using Docker Compose, it's easy to tear it al > **Using the GUI for Compose stacks** > > Note that if you remove the containers for a Compose app in the GUI, it's removing only the containers. You'll have to manually remove the network and volumes if you want to do so. - { .important } In this walkthrough, you learned how to use Docker Compose to start and stop a multi-container application. diff --git a/content/guides/resources.md b/content/guides/resources.md index 0e4bc3bd88..8fe0d64358 100644 --- a/content/guides/resources.md +++ b/content/guides/resources.md @@ -72,7 +72,7 @@ A number of Docker Captains have also created video courses on Docker and Kubern ## Community-translated docs -> **Note** +> [!NOTE] > > The following section contains a subset of Docker docs that are translated by community > members. This is not an officially translated version of Docker docs and it may not be up to date. diff --git a/content/guides/use-case/genai-pdf-bot/containerize.md b/content/guides/use-case/genai-pdf-bot/containerize.md index 78ee78f7c1..40b7c42e5f 100644 --- a/content/guides/use-case/genai-pdf-bot/containerize.md +++ b/content/guides/use-case/genai-pdf-bot/containerize.md @@ -6,7 +6,7 @@ description: Learn how to containerize a generative AI (GenAI) application. ## Prerequisites -> **Note** +> [!NOTE] > > GenAI applications can often benefit from GPU acceleration. Currently Docker Desktop supports GPU acceleration only on [Windows with the WSL2 backend](../../../desktop/gpu.md#using-nvidia-gpus-with-wsl2). Linux users can also access GPU acceleration using a native installation of the [Docker Engine](../../../engine/install/_index.md). @@ -17,7 +17,7 @@ description: Learn how to containerize a generative AI (GenAI) application. This section walks you through containerizing a generative AI (GenAI) application using Docker Desktop. -> **Note** +> [!NOTE] > > You can see more samples of containerized GenAI applications in the [GenAI Stack](https://github.com/docker/genai-stack) demo applications. diff --git a/content/guides/use-case/genai-pdf-bot/develop.md b/content/guides/use-case/genai-pdf-bot/develop.md index 0f77fa93f8..87bf945914 100644 --- a/content/guides/use-case/genai-pdf-bot/develop.md +++ b/content/guides/use-case/genai-pdf-bot/develop.md @@ -15,7 +15,7 @@ In this section, you'll learn how to set up a development environment to access - Adding a local database - Adding a local or remote LLM service -> **Note** +> [!NOTE] > > You can see more samples of containerized GenAI applications in the [GenAI Stack](https://github.com/docker/genai-stack) demo applications. @@ -60,7 +60,7 @@ To run the database service: retries: 5 ``` - > **Note** + > [!NOTE] > > To learn more about Neo4j, see the [Neo4j Official Docker Image](https://hub.docker.com/_/neo4j). @@ -144,7 +144,7 @@ To run Ollama in a container and provide GPU access: ollama_volume: ``` - > **Note** + > [!NOTE] > > For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](../../../compose/gpu-support.md). @@ -191,10 +191,9 @@ To run Ollama outside of a container: {{< /tab >}} {{< tab name="Use OpenAI" >}} -> **Important** +> [!IMPORTANT] > > Using OpenAI requires an [OpenAI account](https://platform.openai.com/login). OpenAI is a third-party hosted service and charges may apply. -{ .important } 1. Update the `LLM` value in your `.env` file to `gpt-3.5`. diff --git a/content/guides/use-case/genai-video-bot/_index.md b/content/guides/use-case/genai-video-bot/_index.md index fbe823fdcf..0efdad69d4 100644 --- a/content/guides/use-case/genai-video-bot/_index.md +++ b/content/guides/use-case/genai-video-bot/_index.md @@ -29,7 +29,7 @@ The project showcases the following technologies: - You have an [OpenAI API Key](https://platform.openai.com/api-keys). - > **Note** + > [!NOTE] > > OpenAI is a third-party hosted service and [charges](https://openai.com/pricing) may apply. @@ -126,7 +126,7 @@ The dockerbot service is a question-answering service that leverages both the Pinecone database and an AI model to provide responses. The following steps show how to use the service. -> **Note** +> [!NOTE] > > You must process at least one video via the > [yt-whisper service](#using-the-yt-whisper-service) before using @@ -246,4 +246,4 @@ OpenAI's cookbook for Explore how to [create a PDF bot application](../genai-pdf-bot/_index.md) using generative AI, or view more GenAI samples in the -[GenAI Stack](https://github.com/docker/genai-stack) repository. \ No newline at end of file +[GenAI Stack](https://github.com/docker/genai-stack) repository. diff --git a/content/guides/use-case/nlp/language-translation.md b/content/guides/use-case/nlp/language-translation.md index 4fc8b37d92..c0f97eb557 100644 --- a/content/guides/use-case/nlp/language-translation.md +++ b/content/guides/use-case/nlp/language-translation.md @@ -298,7 +298,7 @@ To run the application using Docker: For more details, see the [docker run CLI reference](/reference/cli/docker/container/run/). - > **Note** + > [!NOTE] > > For Windows users, you may get an error when running the container. Verify > that the line endings in the `entrypoint.sh` are `LF` (`\n`) and not `CRLF` (`\r\n`), diff --git a/content/guides/use-case/nlp/named-entity-recognition.md b/content/guides/use-case/nlp/named-entity-recognition.md index f3d8722bed..ec3d9fda6c 100644 --- a/content/guides/use-case/nlp/named-entity-recognition.md +++ b/content/guides/use-case/nlp/named-entity-recognition.md @@ -306,7 +306,7 @@ To run the application using Docker: For more details, see the [docker run CLI reference](/reference/cli/docker/container/run/). - > **Note** + > [!NOTE] > > For Windows users, you may get an error when running the container. Verify > that the line endings in the `entrypoint.sh` are `LF` (`\n`) and not `CRLF` (`\r\n`), diff --git a/content/guides/use-case/nlp/sentiment-analysis.md b/content/guides/use-case/nlp/sentiment-analysis.md index 6f6a5ec3e5..5d772ee30f 100644 --- a/content/guides/use-case/nlp/sentiment-analysis.md +++ b/content/guides/use-case/nlp/sentiment-analysis.md @@ -318,7 +318,7 @@ To run the application using Docker: For more details, see the [docker run CLI reference](/reference/cli/docker/container/run/). - > **Note** + > [!NOTE] > > For Windows users, you may get an error when running the container. Verify > that the line endings in the `entrypoint.sh` are `LF` (`\n`) and not `CRLF` (`\r\n`), diff --git a/content/guides/use-case/nlp/text-classification.md b/content/guides/use-case/nlp/text-classification.md index 7efae0bc45..862462aff7 100644 --- a/content/guides/use-case/nlp/text-classification.md +++ b/content/guides/use-case/nlp/text-classification.md @@ -377,7 +377,7 @@ To run the application using Docker: For more details, see the [docker run CLI reference](/reference/cli/docker/container/run/). - > **Note** + > [!NOTE] > > For Windows users, you may get an error when running the container. Verify > that the line endings in the `entrypoint.sh` are `LF` (`\n`) and not `CRLF` (`\r\n`), diff --git a/content/guides/use-case/nlp/text-summarization.md b/content/guides/use-case/nlp/text-summarization.md index d074c48363..6a03814756 100644 --- a/content/guides/use-case/nlp/text-summarization.md +++ b/content/guides/use-case/nlp/text-summarization.md @@ -312,7 +312,7 @@ To run the application using Docker: For more details, see the [docker run CLI reference](/reference/cli/docker/container/run/). - > **Note** + > [!NOTE] > > For Windows users, you may get an error when running the container. Verify > that the line endings in the `entrypoint.sh` are `LF` (`\n`) and not `CRLF` (`\r\n`), diff --git a/content/guides/use-case/tensorflowjs.md b/content/guides/use-case/tensorflowjs.md index ef08eb4e55..5d6f23dff6 100644 --- a/content/guides/use-case/tensorflowjs.md +++ b/content/guides/use-case/tensorflowjs.md @@ -537,4 +537,4 @@ Related information: - [Dockerfile reference](/reference/dockerfile/) - [Compose file reference](../../compose/compose-file/_index.md) - [Docker CLI reference](/reference/cli/docker/) -- [Docker Blog: Accelerating Machine Learning with TensorFlow.js](https://www.docker.com/blog/accelerating-machine-learning-with-tensorflow-js-using-pretrained-models-and-docker/) \ No newline at end of file +- [Docker Blog: Accelerating Machine Learning with TensorFlow.js](https://www.docker.com/blog/accelerating-machine-learning-with-tensorflow-js-using-pretrained-models-and-docker/) diff --git a/content/guides/workshop/04_sharing_app.md b/content/guides/workshop/04_sharing_app.md index b1b7d33b23..f1b0a536cf 100644 --- a/content/guides/workshop/04_sharing_app.md +++ b/content/guides/workshop/04_sharing_app.md @@ -70,7 +70,7 @@ In the following image, you can see an example Docker command from Docker Hub. T Now that your image has been built and pushed into a registry, try running your app on a brand new instance that has never seen this container image. To do this, you will use Play with Docker. -> **Note** +> [!NOTE] > > Play with Docker uses the amd64 platform. If you are using an ARM based Mac with Apple silicon, you will need to rebuild the image to be compatible with Play with Docker and push the new image to your repository. > @@ -100,7 +100,7 @@ new instance that has never seen this container image. To do this, you will use You should see the image get pulled down and eventually start up. - > **Tip** + > [!TIP] > > You may have noticed that this command binds the port mapping to a > different IP address. Previous `docker run` commands published ports to @@ -112,7 +112,6 @@ new instance that has never seen this container image. To do this, you will use > > For more information about how port mapping works, see > [Networking](/engine/network/_index.md#published-ports). - { .tip } 6. Select the 3000 badge when it appears. @@ -136,4 +135,4 @@ Related information: In the next section, you'll learn how to persist data in your containerized application. -{{< button text="Persist the DB" url="05_persisting_data.md" >}} \ No newline at end of file +{{< button text="Persist the DB" url="05_persisting_data.md" >}} diff --git a/content/guides/workshop/05_persisting_data.md b/content/guides/workshop/05_persisting_data.md index 5d57086d0d..3171c5706c 100644 --- a/content/guides/workshop/05_persisting_data.md +++ b/content/guides/workshop/05_persisting_data.md @@ -108,7 +108,7 @@ You can create the volume and start the container using the CLI or Docker Deskto $ docker run -dp 127.0.0.1:3000:3000 --mount type=volume,src=todo-db,target=/etc/todos getting-started ``` - > **Note** + > [!NOTE] > > If you're using Git Bash, you must use different syntax for this command. > @@ -140,10 +140,9 @@ To start the todo app container with the volume mounted: 2. In the search window, select the **Images** tab. 3. In the search box, specify the image name, `getting-started`. - > **Tip** + > [!TIP] > > Use the search filter to filter images and only show **Local images**. - { .tip } 4. Select your image and then select **Run**. 5. Select **Optional settings**. diff --git a/content/guides/workshop/06_bind_mounts.md b/content/guides/workshop/06_bind_mounts.md index f7d64fbd60..a2a7040fd9 100644 --- a/content/guides/workshop/06_bind_mounts.md +++ b/content/guides/workshop/06_bind_mounts.md @@ -356,10 +356,9 @@ Run the image with a bind mount. 2. In the search window, select the **Images** tab. 3. In the search box, specify the container name, `getting-started`. - > **Tip** + > [!TIP] > > Use the search filter to filter images and only show **Local images**. - { .tip } 4. Select your image and then select **Run**. 5. Select **Optional settings**. diff --git a/content/guides/workshop/07_multi_container.md b/content/guides/workshop/07_multi_container.md index 2f06d057b1..3f991e66c0 100644 --- a/content/guides/workshop/07_multi_container.md +++ b/content/guides/workshop/07_multi_container.md @@ -86,10 +86,9 @@ In the following steps, you'll create the network first and then attach the MySQ In the previous command, you can see the `--network-alias` flag. In a later section, you'll learn more about this flag. - > **Tip** + > [!TIP] > > You'll notice a volume named `todo-mysql-data` in the above command that is mounted at `/var/lib/mysql`, which is where MySQL stores its data. However, you never ran a `docker volume create` command. Docker recognizes you want to use a named volume and creates one automatically for you. - { .tip } 3. To confirm you have the database up and running, connect to the database and verify that it connects. @@ -186,7 +185,7 @@ The todo app supports the setting of a few environment variables to specify MySQ - `MYSQL_PASSWORD` - the password to use for the connection - `MYSQL_DB` - the database to use once connected -> **Note** +> [!NOTE] > > While using env vars to set connection settings is generally accepted for development, it's highly discouraged > when running applications in production. Diogo Monica, a former lead of security at Docker, diff --git a/content/guides/workshop/08_using_compose.md b/content/guides/workshop/08_using_compose.md index 421228f4bc..972253c5eb 100644 --- a/content/guides/workshop/08_using_compose.md +++ b/content/guides/workshop/08_using_compose.md @@ -271,7 +271,6 @@ for the entire app. The containers will stop and the network will be removed. >remove the volumes, you need to add the `--volumes` flag. > >The Docker Dashboard does not remove volumes when you delete the app stack. -{ .warning } ## Summary diff --git a/content/guides/workshop/10_what_next.md b/content/guides/workshop/10_what_next.md index 6e01b8b36e..8b3df79db2 100644 --- a/content/guides/workshop/10_what_next.md +++ b/content/guides/workshop/10_what_next.md @@ -51,4 +51,4 @@ If you'd like to see how containers are built from scratch, Liz Rice from Aqua S ## Language-specific guides -If you are looking for information on how to containerize an application using your favorite language, see the [Language-specific guides](../../language/_index.md). \ No newline at end of file +If you are looking for information on how to containerize an application using your favorite language, see the [Language-specific guides](../../language/_index.md). diff --git a/content/guides/workshop/_index.md b/content/guides/workshop/_index.md index aec92ec8e7..21826279a2 100644 --- a/content/guides/workshop/_index.md +++ b/content/guides/workshop/_index.md @@ -69,7 +69,7 @@ This 45-minute workshop contains step-by-step instructions on how to get started - Deploy Docker applications using multiple containers with a database. - Run applications using Docker Compose. -> **Note** +> [!NOTE] > > For a quick introduction to Docker and the benefits of containerizing your > applications, see [Getting started](../getting-started/_index.md). diff --git a/content/includes/aci-ecs-eol.md b/content/includes/aci-ecs-eol.md index 10ab16a360..514c11a0da 100644 --- a/content/includes/aci-ecs-eol.md +++ b/content/includes/aci-ecs-eol.md @@ -1,4 +1,3 @@ >**Important** > >Docker Compose's integration for ECS and ACI is retiring in November 2023. -{ .important } \ No newline at end of file diff --git a/content/includes/admin-company-overview.md b/content/includes/admin-company-overview.md index 39bdb1cc0c..15a6237114 100644 --- a/content/includes/admin-company-overview.md +++ b/content/includes/admin-company-overview.md @@ -20,4 +20,4 @@ Before you create a company, verify the following: - Any organizations you want to add to a company have a Docker Business subscription - You're an organization owner -- You're an organization owner for any additional organizations you want to add to the company you create \ No newline at end of file +- You're an organization owner for any additional organizations you want to add to the company you create diff --git a/content/includes/admin-early-access.md b/content/includes/admin-early-access.md index 4e92a39735..7c577839f0 100644 --- a/content/includes/admin-early-access.md +++ b/content/includes/admin-early-access.md @@ -3,4 +3,4 @@ > The Docker Admin Console is an [early access](/release-lifecycle#early-access-ea) product. > > It's available to all company owners and organization owners. You can still manage companies and organizations in Docker Hub, but the Admin Console includes enhanced features for company-level management. -{ .restricted } \ No newline at end of file +{ .restricted } diff --git a/content/includes/admin-org-overview.md b/content/includes/admin-org-overview.md index 62bf6c4212..3aff83bc2f 100644 --- a/content/includes/admin-org-overview.md +++ b/content/includes/admin-org-overview.md @@ -11,4 +11,4 @@ organization. The following diagram depicts the setup of an organization and how it relates to teams. Teams are an optional feature that owners can use to group members and assign permissions. -![organization-hierarchy](/admin/images/org-structure.webp) \ No newline at end of file +![organization-hierarchy](/admin/images/org-structure.webp) diff --git a/content/includes/beta.md b/content/includes/beta.md index 6b54157cff..b3d94642f2 100644 --- a/content/includes/beta.md +++ b/content/includes/beta.md @@ -2,4 +2,4 @@ Beta features provide access to future product functionality. These features are intended for testing and feedback only as they may change between releases without warning or remove them entirely from a future release. Beta features must not be used in production environments. -Docker doesn't offer support for beta features. \ No newline at end of file +Docker doesn't offer support for beta features. diff --git a/content/includes/buildx-v0.10-disclaimer.md b/content/includes/buildx-v0.10-disclaimer.md index 7c2ebb79cc..855bc5f58b 100644 --- a/content/includes/buildx-v0.10-disclaimer.md +++ b/content/includes/buildx-v0.10-disclaimer.md @@ -1,8 +1,8 @@ -> **Note** +> [!NOTE] > > Buildx v0.10 enables support for a minimal [SLSA Provenance](https://slsa.dev/provenance/) > attestation, which requires support for [OCI-compliant](https://github.com/opencontainers/image-spec) > multi-platform images. This may introduce issues with registry and runtime support > (e.g. [Google Cloud Run and AWS Lambda](https://github.com/docker/buildx/issues/1533)). > You can optionally disable the default provenance attestation functionality -> using `--provenance=false`. \ No newline at end of file +> using `--provenance=false`. diff --git a/content/includes/compose-bridge-early-access.md b/content/includes/compose-bridge-early-access.md index 21b1de8796..c5faccd334 100644 --- a/content/includes/compose-bridge-early-access.md +++ b/content/includes/compose-bridge-early-access.md @@ -4,4 +4,4 @@ > > If you would like to be considered for Compose Bridge testing, you can > [sign up for the Early Access program](https://www.docker.com/docker-desktop-preview-program/). -{ .restricted } \ No newline at end of file +{ .restricted } diff --git a/content/includes/compose-eol.md b/content/includes/compose-eol.md index 1368d0d82e..711d408801 100644 --- a/content/includes/compose-eol.md +++ b/content/includes/compose-eol.md @@ -1,6 +1,5 @@ -> **Important** +> [!IMPORTANT] > > Docker's documentation refers to and describes Compose V2 functionality. > > Effective July 2023, Compose V1 stopped receiving updates and is no longer in new Docker Desktop releases. Compose V2 has replaced it and is now integrated into all current Docker Desktop versions. For more information, see [Migrate to Compose V2](/compose/migrate). -{ .important } \ No newline at end of file diff --git a/content/includes/compose/build.md b/content/includes/compose/build.md index 0a9cc70bfb..687649fc4e 100644 --- a/content/includes/compose/build.md +++ b/content/includes/compose/build.md @@ -1 +1 @@ -Build is an optional part of the Compose Specification. It tells Compose how to (re)build an application from source and lets you define the build process within a Compose file in a portable way. `build` can be either specified as a single string defining a context path, or as a detailed build definition. \ No newline at end of file +Build is an optional part of the Compose Specification. It tells Compose how to (re)build an application from source and lets you define the build process within a Compose file in a portable way. `build` can be either specified as a single string defining a context path, or as a detailed build definition. diff --git a/content/includes/compose/configs.md b/content/includes/compose/configs.md index 2a334935f9..639b679661 100644 --- a/content/includes/compose/configs.md +++ b/content/includes/compose/configs.md @@ -1 +1 @@ -Configs let services to adapt their behaviour without the need to rebuild a Docker image. As with volumes, configs are mounted as files into a container's filesystem. The location of the mount point within the container defaults to `/` in Linux containers and `C:\` in Windows containers. \ No newline at end of file +Configs let services to adapt their behaviour without the need to rebuild a Docker image. As with volumes, configs are mounted as files into a container's filesystem. The location of the mount point within the container defaults to `/` in Linux containers and `C:\` in Windows containers. diff --git a/content/includes/compose/configure-watch.md b/content/includes/compose/configure-watch.md index 71dfe8288f..19987e17be 100644 --- a/content/includes/compose/configure-watch.md +++ b/content/includes/compose/configure-watch.md @@ -1,3 +1,3 @@ 1. Add `watch` sections to one or more services in `compose.yaml`. 2. Run `docker compose up --watch` to build and launch a Compose project and start the file watch mode. -3. Edit service source files using your preferred IDE or editor. \ No newline at end of file +3. Edit service source files using your preferred IDE or editor. diff --git a/content/includes/compose/deploy.md b/content/includes/compose/deploy.md index 6986dd89d7..9f7450b505 100644 --- a/content/includes/compose/deploy.md +++ b/content/includes/compose/deploy.md @@ -1 +1 @@ -Deploy is an optional part of the Compose Specification. It provides a set of deployment specifications for managing the behavior of containers across different environments. \ No newline at end of file +Deploy is an optional part of the Compose Specification. It provides a set of deployment specifications for managing the behavior of containers across different environments. diff --git a/content/includes/compose/extension.md b/content/includes/compose/extension.md index 20b4ad6b61..edbbd4edb4 100644 --- a/content/includes/compose/extension.md +++ b/content/includes/compose/extension.md @@ -1,4 +1,4 @@ Extensions can be used to make your Compose file more efficient and easier to maintain. Use the prefix `x-` as a top-level element to modularize configurations that you want to reuse. -Compose ignores any fields that start with `x-`, this is the sole exception where Compose silently ignores unrecognized fields. \ No newline at end of file +Compose ignores any fields that start with `x-`, this is the sole exception where Compose silently ignores unrecognized fields. diff --git a/content/includes/compose/fragments.md b/content/includes/compose/fragments.md index 7820e2ca89..b4f56ed6db 100644 --- a/content/includes/compose/fragments.md +++ b/content/includes/compose/fragments.md @@ -1 +1 @@ -With Compose, you can use built-in [YAML](https://www.yaml.org/spec/1.2/spec.html#id2765878) features to make your Compose file neater and more efficient. Anchors and aliases let you create re-usable blocks. This is useful if you start to find common configurations that span multiple services. Having re-usable blocks minimizes potential mistakes. \ No newline at end of file +With Compose, you can use built-in [YAML](https://www.yaml.org/spec/1.2/spec.html#id2765878) features to make your Compose file neater and more efficient. Anchors and aliases let you create re-usable blocks. This is useful if you start to find common configurations that span multiple services. Having re-usable blocks minimizes potential mistakes. diff --git a/content/includes/compose/include.md b/content/includes/compose/include.md index 7e732aa2a4..3e05b9f4d6 100644 --- a/content/includes/compose/include.md +++ b/content/includes/compose/include.md @@ -1 +1 @@ -With `include`, you can incorporate a separate `compose.yaml` file directly in your current `compose.yaml` file. This makes it easy to modularize complex applications into sub-Compose files, which in turn enables application configurations to be made simpler and more explicit. \ No newline at end of file +With `include`, you can incorporate a separate `compose.yaml` file directly in your current `compose.yaml` file. This makes it easy to modularize complex applications into sub-Compose files, which in turn enables application configurations to be made simpler and more explicit. diff --git a/content/includes/compose/interpolation.md b/content/includes/compose/interpolation.md index 5f540009ba..f5888898ee 100644 --- a/content/includes/compose/interpolation.md +++ b/content/includes/compose/interpolation.md @@ -1,2 +1,2 @@ Values in a Compose file can be set by variables and interpolated at runtime. Compose files use a Bash-like -syntax `${VARIABLE}`. Both `$VARIABLE` and `${VARIABLE}` syntax is supported. \ No newline at end of file +syntax `${VARIABLE}`. Both `$VARIABLE` and `${VARIABLE}` syntax is supported. diff --git a/content/includes/compose/merge.md b/content/includes/compose/merge.md index d413a20379..f327f3c922 100644 --- a/content/includes/compose/merge.md +++ b/content/includes/compose/merge.md @@ -1,2 +1,2 @@ Compose lets you define a Compose application model through multiple Compose files. -When doing so, Compose follows certain rules to merge Compose files. \ No newline at end of file +When doing so, Compose follows certain rules to merge Compose files. diff --git a/content/includes/compose/networks.md b/content/includes/compose/networks.md index 6f31634bcf..894712768e 100644 --- a/content/includes/compose/networks.md +++ b/content/includes/compose/networks.md @@ -1 +1 @@ -Networks let services communicate with each other. By default Compose sets up a single network for your app. Each container for a service joins the default network and is both reachable by other containers on that network, and discoverable by the service's name. The top-level `networks` element lets you configure named networks that can be reused across multiple services. \ No newline at end of file +Networks let services communicate with each other. By default Compose sets up a single network for your app. Each container for a service joins the default network and is both reachable by other containers on that network, and discoverable by the service's name. The top-level `networks` element lets you configure named networks that can be reused across multiple services. diff --git a/content/includes/compose/profiles.md b/content/includes/compose/profiles.md index 1f3d95df8a..03802cedba 100644 --- a/content/includes/compose/profiles.md +++ b/content/includes/compose/profiles.md @@ -1 +1 @@ -Profiles help you adjust your Compose application for different environments or use cases by selectively activating services. Services can be assigned to one or more profiles; unassigned services start by default, while assigned ones only start when their profile is active. This setup means specific services, like those for debugging or development, to be included in a single `compose.yml` file and activated only as needed. \ No newline at end of file +Profiles help you adjust your Compose application for different environments or use cases by selectively activating services. Services can be assigned to one or more profiles; unassigned services start by default, while assigned ones only start when their profile is active. This setup means specific services, like those for debugging or development, to be included in a single `compose.yml` file and activated only as needed. diff --git a/content/includes/compose/secrets.md b/content/includes/compose/secrets.md index d3ed36f23a..c49b32c63c 100644 --- a/content/includes/compose/secrets.md +++ b/content/includes/compose/secrets.md @@ -1 +1 @@ -Docker Compose provides a way for you to use secrets without having to use environment variables to store information. If you’re injecting passwords and API keys as environment variables, you risk unintentional information exposure. Services can only access secrets when explicitly granted by a `secrets` attribute within the `services` top-level element. \ No newline at end of file +Docker Compose provides a way for you to use secrets without having to use environment variables to store information. If you’re injecting passwords and API keys as environment variables, you risk unintentional information exposure. Services can only access secrets when explicitly granted by a `secrets` attribute within the `services` top-level element. diff --git a/content/includes/compose/services-depends-on.md b/content/includes/compose/services-depends-on.md index afb8ae34fe..ffbddb9433 100644 --- a/content/includes/compose/services-depends-on.md +++ b/content/includes/compose/services-depends-on.md @@ -1 +1 @@ -With the `depends_on` attribute, you can control the order of service startup and shutdown. It is useful if services are closely coupled, and the startup sequence impacts the application's functionality. \ No newline at end of file +With the `depends_on` attribute, you can control the order of service startup and shutdown. It is useful if services are closely coupled, and the startup sequence impacts the application's functionality. diff --git a/content/includes/compose/services-develop.md b/content/includes/compose/services-develop.md index 4aa5e6127e..0a0e35fbce 100644 --- a/content/includes/compose/services-develop.md +++ b/content/includes/compose/services-develop.md @@ -1 +1 @@ -Develop lets Compose focus on the development use-case of running applications on a local machine. It also supports some development hooks to improve the velocity of your local workflow, also known as your "inner loop". \ No newline at end of file +Develop lets Compose focus on the development use-case of running applications on a local machine. It also supports some development hooks to improve the velocity of your local workflow, also known as your "inner loop". diff --git a/content/includes/compose/services-env-file.md b/content/includes/compose/services-env-file.md index 86216aa34c..91f769ee19 100644 --- a/content/includes/compose/services-env-file.md +++ b/content/includes/compose/services-env-file.md @@ -1 +1 @@ -The `env_file` attribute is used to specify one or more files that contain environment variables to be passed to the containers. \ No newline at end of file +The `env_file` attribute is used to specify one or more files that contain environment variables to be passed to the containers. diff --git a/content/includes/compose/services-environment.md b/content/includes/compose/services-environment.md index a27d779c8c..2b22c9f130 100644 --- a/content/includes/compose/services-environment.md +++ b/content/includes/compose/services-environment.md @@ -1,3 +1,3 @@ The `environment` attribute defines environment variables set in the container. `environment` can use either an array or a map. Any boolean values; true, false, yes, no, should be enclosed in quotes to ensure -they are not converted to True or False by the YAML parser. \ No newline at end of file +they are not converted to True or False by the YAML parser. diff --git a/content/includes/compose/services-healthcheck.md b/content/includes/compose/services-healthcheck.md index ce981ae1ae..0129626ddb 100644 --- a/content/includes/compose/services-healthcheck.md +++ b/content/includes/compose/services-healthcheck.md @@ -1,2 +1,2 @@ The `healthcheck` attribute declares a check that's run to determine whether or not the service containers are "healthy". It works in the same way, and has the same default values, as the HEALTHCHECK Dockerfile instruction -set by the service's Docker image. Your Compose file can override the values set in the Dockerfile. \ No newline at end of file +set by the service's Docker image. Your Compose file can override the values set in the Dockerfile. diff --git a/content/includes/compose/services-networks.md b/content/includes/compose/services-networks.md index e7e431f123..85611c4ea2 100644 --- a/content/includes/compose/services-networks.md +++ b/content/includes/compose/services-networks.md @@ -1,2 +1,2 @@ The `networks` attribute defines the networks that service containers are attached to, referencing entries under the -`networks` top-level element. The `networks` attribute helps manage the networking aspects of containers, providing control over how services are segmented and interact within the Docker environment. This is used to specify which networks the containers for that service should connect to. This is important for defining how containers communicate with each other and externally. \ No newline at end of file +`networks` top-level element. The `networks` attribute helps manage the networking aspects of containers, providing control over how services are segmented and interact within the Docker environment. This is used to specify which networks the containers for that service should connect to. This is important for defining how containers communicate with each other and externally. diff --git a/content/includes/compose/services-ports.md b/content/includes/compose/services-ports.md index 2e51f449f5..ee4c22a0de 100644 --- a/content/includes/compose/services-ports.md +++ b/content/includes/compose/services-ports.md @@ -1 +1 @@ -The `ports` is used to define the port mappings between the host machine and the containers. This is crucial for allowing external access to services running inside containers. It can be defined using short syntax for simple port mapping or long syntax, which includes additional options like protocol type and network mode. \ No newline at end of file +The `ports` is used to define the port mappings between the host machine and the containers. This is crucial for allowing external access to services running inside containers. It can be defined using short syntax for simple port mapping or long syntax, which includes additional options like protocol type and network mode. diff --git a/content/includes/compose/services-secrets.md b/content/includes/compose/services-secrets.md index 5f7ddbcda8..99db71b960 100644 --- a/content/includes/compose/services-secrets.md +++ b/content/includes/compose/services-secrets.md @@ -1 +1 @@ -The `secrets` attribute grants access to sensitive data defined by the secrets top-level element on a per-service basis. Services can be granted access to multiple secrets. \ No newline at end of file +The `secrets` attribute grants access to sensitive data defined by the secrets top-level element on a per-service basis. Services can be granted access to multiple secrets. diff --git a/content/includes/compose/services-volumes.md b/content/includes/compose/services-volumes.md index 465ace4402..ee8cf679cc 100644 --- a/content/includes/compose/services-volumes.md +++ b/content/includes/compose/services-volumes.md @@ -2,4 +2,4 @@ The `volumes` attribute define mount host paths or named volumes that are access If the mount is a host path and is only used by a single service, it can be declared as part of the service definition. To reuse a volume across multiple services, a named -volume must be declared in the `volumes` top-level element. \ No newline at end of file +volume must be declared in the `volumes` top-level element. diff --git a/content/includes/compose/services.md b/content/includes/compose/services.md index 438ad75905..b36cf9c08d 100644 --- a/content/includes/compose/services.md +++ b/content/includes/compose/services.md @@ -2,4 +2,4 @@ A service is an abstract definition of a computing resource within an applicatio independently from other components. Services are backed by a set of containers, run by the platform according to replication requirements and placement constraints. As services are backed by containers, they are defined by a Docker image and set of runtime arguments. All containers within a service are identically created with these -arguments. \ No newline at end of file +arguments. diff --git a/content/includes/compose/volumes.md b/content/includes/compose/volumes.md index 72c8e6f8a6..20a279370e 100644 --- a/content/includes/compose/volumes.md +++ b/content/includes/compose/volumes.md @@ -1 +1 @@ -Volumes are persistent data stores implemented by the container engine. Compose offers a neutral way for services to mount volumes, and configuration parameters to allocate them to infrastructure. The top-level `volumes` declaration lets you configure named volumes that can be reused across multiple services. \ No newline at end of file +Volumes are persistent data stores implemented by the container engine. Compose offers a neutral way for services to mount volumes, and configuration parameters to allocate them to infrastructure. The top-level `volumes` declaration lets you configure named volumes that can be reused across multiple services. diff --git a/content/includes/compose/watch.md b/content/includes/compose/watch.md index 25650b0838..2d0dd1fdac 100644 --- a/content/includes/compose/watch.md +++ b/content/includes/compose/watch.md @@ -1 +1 @@ -The `watch` attribute automatically updates and previews your running Compose services as you edit and save your code. For many projects, this enables a hands-off development workflow once Compose is running, as services automatically update themselves when you save your work. \ No newline at end of file +The `watch` attribute automatically updates and previews your running Compose services as you edit and save your code. For many projects, this enables a hands-off development workflow once Compose is running, as services automatically update themselves when you save your work. diff --git a/content/includes/deploy.md b/content/includes/deploy.md index 1d27fd8ac7..44d9ff2be0 100644 --- a/content/includes/deploy.md +++ b/content/includes/deploy.md @@ -25,4 +25,4 @@ To enable Kubernetes: This starts a Kubernetes single-node cluster when Docker Desktop starts. -For detailed information, see [Deploy on Kubernetes](/desktop/kubernetes/) and [Describing apps using Kubernetes YAML](/guides/deployment-orchestration/kube-deploy/#describing-apps-using-kubernetes-yaml). \ No newline at end of file +For detailed information, see [Deploy on Kubernetes](/desktop/kubernetes/) and [Describing apps using Kubernetes YAML](/guides/deployment-orchestration/kube-deploy/#describing-apps-using-kubernetes-yaml). diff --git a/content/includes/desktop-experimental.md b/content/includes/desktop-experimental.md index cf7955a21f..f2f772bfe6 100644 --- a/content/includes/desktop-experimental.md +++ b/content/includes/desktop-experimental.md @@ -1,3 +1,3 @@ On the **Experimental features** tab, you have the option to allow feature flags. These are features that Docker is currently experimenting with. This is switched on by default. -These features are intended for testing and feedback only as they may change between releases without warning or remove them entirely from a future release. Docker doesn't offer support for experimental features. \ No newline at end of file +These features are intended for testing and feedback only as they may change between releases without warning or remove them entirely from a future release. Docker doesn't offer support for experimental features. diff --git a/content/includes/desktop-license-update.md b/content/includes/desktop-license-update.md index 96dfd4834d..35af70f61e 100644 --- a/content/includes/desktop-license-update.md +++ b/content/includes/desktop-license-update.md @@ -3,4 +3,4 @@ Here’s a summary of the key points: - Docker Desktop is free for small businesses (fewer than 250 employees AND less than $10 million in annual revenue), personal use, education, and non-commercial open source projects. - Otherwise, it requires a paid subscription for professional use. - Paid subscriptions are also required for government entities. -- The Docker Pro, Team, and Business subscriptions include commercial use of Docker Desktop. \ No newline at end of file +- The Docker Pro, Team, and Business subscriptions include commercial use of Docker Desktop. diff --git a/content/includes/desktop-linux-launch.md b/content/includes/desktop-linux-launch.md index 97e2578386..88d68e92a9 100644 --- a/content/includes/desktop-linux-launch.md +++ b/content/includes/desktop-linux-launch.md @@ -61,4 +61,4 @@ Alternatively, open a terminal and run: ```console $ systemctl --user stop docker-desktop -``` \ No newline at end of file +``` diff --git a/content/includes/desktop-notifications-settings.md b/content/includes/desktop-notifications-settings.md index 2e4ac279d3..0881c26b08 100644 --- a/content/includes/desktop-notifications-settings.md +++ b/content/includes/desktop-notifications-settings.md @@ -6,4 +6,4 @@ Use the **Notifications** tab to turn on or turn off notifications for the follo By default, all notifications are turned on. You'll always receive error notifications and notifications about new Docker Desktop releases and updates. -Notifications momentarily appear in the lower-right of the Docker Dashboard and then move to the **Notifications** drawer. To open the **Notifications** drawer, select {{< inline-image src="../images/notifications.svg" alt="notifications" >}}. \ No newline at end of file +Notifications momentarily appear in the lower-right of the Docker Dashboard and then move to the **Notifications** drawer. To open the **Notifications** drawer, select {{< inline-image src="../images/notifications.svg" alt="notifications" >}}. diff --git a/content/includes/dev-envs-changing.md b/content/includes/dev-envs-changing.md index 462a0e608b..edd3984a57 100644 --- a/content/includes/dev-envs-changing.md +++ b/content/includes/dev-envs-changing.md @@ -1,6 +1,5 @@ -> **Important** +> [!IMPORTANT] > > Dev Environments is no longer under active development. > > While the current functionality remains available, it may take us longer to respond to support requests. -{ .important } \ No newline at end of file diff --git a/content/includes/dockerfile-labs-channel.md b/content/includes/dockerfile-labs-channel.md index b311f14cde..1024fbc8db 100644 --- a/content/includes/dockerfile-labs-channel.md +++ b/content/includes/dockerfile-labs-channel.md @@ -2,4 +2,4 @@ > > The "labs" channel provides early access to Dockerfile features that are not > yet available in the stable channel. -{ .experimental } \ No newline at end of file +{ .experimental } diff --git a/content/includes/experimental.md b/content/includes/experimental.md index ed9afdbb7b..86cebbd3f9 100644 --- a/content/includes/experimental.md +++ b/content/includes/experimental.md @@ -4,4 +4,4 @@ between releases without warning or can be removed entirely from a future release. Experimental features must not be used in production environments. Docker does not offer support for experimental features. -For a list of current experimental features in the Docker CLI, see [Docker CLI Experimental features](https://github.com/docker/cli/blob/master/experimental/README.md). \ No newline at end of file +For a list of current experimental features in the Docker CLI, see [Docker CLI Experimental features](https://github.com/docker/cli/blob/master/experimental/README.md). diff --git a/content/includes/extensions-form.md b/content/includes/extensions-form.md index 9d796435ea..4a165c1c88 100644 --- a/content/includes/extensions-form.md +++ b/content/includes/extensions-form.md @@ -1,3 +1,3 @@ > Already built an extension? > -> Let us know about your experience using the [feedback form](https://survey.alchemer.com/s3/7184948/Publishers-Feedback-Form). \ No newline at end of file +> Let us know about your experience using the [feedback form](https://survey.alchemer.com/s3/7184948/Publishers-Feedback-Form). diff --git a/content/includes/guides-get-docker.md b/content/includes/guides-get-docker.md index 55facaa02b..719f9c9af4 100644 --- a/content/includes/guides-get-docker.md +++ b/content/includes/guides-get-docker.md @@ -1 +1 @@ -Before you start, get the latest version of [Docker Desktop](../../get-docker.md). Docker adds new features regularly and some parts of this guide may work only with the latest version of Docker Desktop. \ No newline at end of file +Before you start, get the latest version of [Docker Desktop](../../get-docker.md). Docker adds new features regularly and some parts of this guide may work only with the latest version of Docker Desktop. diff --git a/content/includes/install-script.md b/content/includes/install-script.md index 348831187c..e0569e63f3 100644 --- a/content/includes/install-script.md +++ b/content/includes/install-script.md @@ -14,7 +14,6 @@ for the script is open source, and you can find it in the Always examine scripts downloaded from the internet before running them locally. Before installing, make yourself familiar with potential risks and limitations of the convenience script: -{ .warning } - The script requires `root` or `sudo` privileges to run. - The script attempts to detect your Linux distribution and version and @@ -90,4 +89,4 @@ $ sudo sh test-docker.sh If you installed Docker using the convenience script, you should upgrade Docker using your package manager directly. There's no advantage to re-running the convenience script. Re-running it can cause issues if it attempts to re-install -repositories which already exist on the host machine. \ No newline at end of file +repositories which already exist on the host machine. diff --git a/content/includes/open-terminal.md b/content/includes/open-terminal.md index 81e5c36569..845154bc21 100644 --- a/content/includes/open-terminal.md +++ b/content/includes/open-terminal.md @@ -1,4 +1,4 @@ -> **Tip** +> [!TIP] > > To run Docker commands, you must use a terminal. Based on your > operating system, you can open a terminal by doing the following: @@ -8,4 +8,3 @@ > > For Mac, select the **Launchpad** icon in the Dock, specify `Terminal` in the > search field, then select **Terminal**. -{ .tip } \ No newline at end of file diff --git a/content/includes/root-errors.md b/content/includes/root-errors.md index f8f12c11a2..b52b6755c3 100644 --- a/content/includes/root-errors.md +++ b/content/includes/root-errors.md @@ -1,8 +1,7 @@ -> **Tip** +> [!TIP] > > Receiving errors when trying to run without root? > > The `docker` user group exists but contains no users, which is why you’re required > to use `sudo` to run Docker commands. Continue to [Linux postinstall](/engine/install/linux-postinstall) > to allow non-privileged users to run Docker commands and for other optional configuration steps. -{ .tip } \ No newline at end of file diff --git a/content/includes/swarm-compose-compat.md b/content/includes/swarm-compose-compat.md index 2868f11bb4..b4a91b4b89 100644 --- a/content/includes/swarm-compose-compat.md +++ b/content/includes/swarm-compose-compat.md @@ -1,4 +1,4 @@ -> **Note** +> [!NOTE] > > The `docker stack deploy` command uses the legacy > [Compose file version 3](/compose/compose-file/compose-file-v3/) @@ -7,4 +7,4 @@ > isn't compatible with the `docker stack deploy` command. > > For more information about the evolution of Compose, see -> [History of Compose](/compose/history/). \ No newline at end of file +> [History of Compose](/compose/history/). diff --git a/content/includes/swarm-mode.md b/content/includes/swarm-mode.md index e1eb88cd26..7a9cc2e1a0 100644 --- a/content/includes/swarm-mode.md +++ b/content/includes/swarm-mode.md @@ -1,4 +1,4 @@ -> **Note** +> [!NOTE] > > Swarm mode is an advanced feature for managing a cluster of Docker daemons. > @@ -7,4 +7,4 @@ > If you're not planning on deploying with Swarm, use > [Docker Compose](/compose/) instead. > If you're developing for a Kubernetes deployment, consider using the -> [integrated Kubernetes feature](/desktop/kubernetes/) in Docker Desktop. \ No newline at end of file +> [integrated Kubernetes feature](/desktop/kubernetes/) in Docker Desktop. diff --git a/content/includes/tax-compliance.md b/content/includes/tax-compliance.md index fdda14bb2b..21aa813db1 100644 --- a/content/includes/tax-compliance.md +++ b/content/includes/tax-compliance.md @@ -1,6 +1,5 @@ -> **Important** +> [!IMPORTANT] > > Starting July 1, 2024, Docker will begin collecting sales tax on subscription fees in compliance with state regulations for customers in the United States. For our global customers subject to VAT, the implementation will start rolling out on July 1, 2024. Note that while the rollout begins on this date, VAT charges may not apply to all applicable subscriptions immediately. > > To ensure that tax assessments are correct, make sure that your [billing information](/billing/core-billing/details/) and VAT/Tax ID, if applicable, are updated. If you're exempt from sales tax, see [Register a tax certificate](/billing/tax-certificate/). -{ .important } \ No newline at end of file diff --git a/content/language/cpp/deploy.md b/content/language/cpp/deploy.md index ed13d42f52..0f166fede7 100644 --- a/content/language/cpp/deploy.md +++ b/content/language/cpp/deploy.md @@ -134,4 +134,4 @@ In this section, you learned how to use Docker Desktop to deploy your C++ applic Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/dotnet/_index.md b/content/language/dotnet/_index.md index 12c3535130..b95f384b2d 100644 --- a/content/language/dotnet/_index.md +++ b/content/language/dotnet/_index.md @@ -18,4 +18,4 @@ After completing the .NET getting started modules, you should be able to contain Start by containerizing an existing .NET application. -{{< button text="Containerize a .NET app" url="containerize.md" >}} \ No newline at end of file +{{< button text="Containerize a .NET app" url="containerize.md" >}} diff --git a/content/language/dotnet/deploy.md b/content/language/dotnet/deploy.md index d475aa3121..65ed4e5e63 100644 --- a/content/language/dotnet/deploy.md +++ b/content/language/dotnet/deploy.md @@ -210,4 +210,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/dotnet/develop.md b/content/language/dotnet/develop.md index aeb9d2eb86..29bbc872cd 100644 --- a/content/language/dotnet/develop.md +++ b/content/language/dotnet/develop.md @@ -116,7 +116,7 @@ secrets: file: db/password.txt ``` -> **Note** +> [!NOTE] > > To learn more about the instructions in the Compose file, see [Compose file > reference](/compose/compose-file/). diff --git a/content/language/dotnet/run-tests.md b/content/language/dotnet/run-tests.md index 7bb25cf043..428dcb1b35 100644 --- a/content/language/dotnet/run-tests.md +++ b/content/language/dotnet/run-tests.md @@ -114,4 +114,4 @@ Related information: Next, you’ll learn how to set up a CI/CD pipeline using GitHub Actions. -{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} \ No newline at end of file +{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} diff --git a/content/language/golang/_index.md b/content/language/golang/_index.md index 768b88ff65..a4a7c1ffe0 100644 --- a/content/language/golang/_index.md +++ b/content/language/golang/_index.md @@ -44,4 +44,4 @@ The aim of this guide is to provide enough examples and instructions for you to Start by building your first Go image. -{{< button text="Build your Go image" url="build-images.md" >}} \ No newline at end of file +{{< button text="Build your Go image" url="build-images.md" >}} diff --git a/content/language/golang/build-images.md b/content/language/golang/build-images.md index f99be92daf..2a04c52e8c 100644 --- a/content/language/golang/build-images.md +++ b/content/language/golang/build-images.md @@ -111,7 +111,7 @@ Docker images can be inherited from other images. Therefore, instead of creating your own base image from scratch, you can use the official Go image that already has all necessary tools and libraries to compile and run a Go application. -> **Note** +> [!NOTE] > > If you are curious about creating your own base images, you can check out the following section of this guide: [creating base images](../../build/building/base-images.md#create-a-base-image). > Note, however, that this isn't necessary to continue with your task at hand. @@ -151,7 +151,7 @@ slash. COPY go.mod go.sum ./ ``` -> **Note** +> [!NOTE] > > If you'd like to familiarize yourself with the trailing slash treatment by the > `COPY` command, see [Dockerfile diff --git a/content/language/golang/deploy.md b/content/language/golang/deploy.md index aad71943d9..99387d7f00 100644 --- a/content/language/golang/deploy.md +++ b/content/language/golang/deploy.md @@ -235,4 +235,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/golang/develop.md b/content/language/golang/develop.md index f31d9b6522..657279dc4b 100644 --- a/content/language/golang/develop.md +++ b/content/language/golang/develop.md @@ -351,7 +351,7 @@ $ docker build --tag docker-gs-ping-roach . Now, run your container. This time you'll need to set some environment variables so that your application knows how to access the database. For now, you’ll do this right in the `docker run` command. Later you'll see a more convenient method with Docker Compose. -> **Note** +> [!NOTE] > > Since you're running your CockroachDB cluster in insecure mode, the value for the password can be anything. > @@ -620,7 +620,7 @@ $ docker compose up --build You passed the `--build` flag so Docker will compile your image and then start it. -> **Note** +> [!NOTE] > > Docker Compose is a useful tool, but it has its own quirks. For example, no rebuild is triggered on the update to the source code unless the `--build` flag is provided. It is a very common pitfall to edit one's source code, and forget to use the `--build` flag when running `docker compose up`. diff --git a/content/language/golang/run-tests.md b/content/language/golang/run-tests.md index a822a53259..34c1667799 100644 --- a/content/language/golang/run-tests.md +++ b/content/language/golang/run-tests.md @@ -93,4 +93,4 @@ To learn more about building and running tests, see the [Build with Docker guide In this section, you learned how to run tests when building your image. Next, you’ll learn how to set up a CI/CD pipeline using GitHub Actions. -{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} \ No newline at end of file +{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} diff --git a/content/language/java/_index.md b/content/language/java/_index.md index 7487d7c9c8..aa26ab189f 100644 --- a/content/language/java/_index.md +++ b/content/language/java/_index.md @@ -18,4 +18,4 @@ After completing the Java getting started modules, you should be able to contain Get started containerizing your first Java app. -{{< button text="Containerize your first Java app" url="containerize.md" >}} \ No newline at end of file +{{< button text="Containerize your first Java app" url="containerize.md" >}} diff --git a/content/language/java/containerize.md b/content/language/java/containerize.md index af28a4de86..5ba4266d91 100644 --- a/content/language/java/containerize.md +++ b/content/language/java/containerize.md @@ -330,4 +330,4 @@ Related information: In the next section, you'll learn how you can develop your application using Docker containers. -{{< button text="Develop your application" url="develop.md" >}} \ No newline at end of file +{{< button text="Develop your application" url="develop.md" >}} diff --git a/content/language/java/deploy.md b/content/language/java/deploy.md index 7867e2e4e8..7322f60671 100644 --- a/content/language/java/deploy.md +++ b/content/language/java/deploy.md @@ -145,4 +145,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/nodejs/_index.md b/content/language/nodejs/_index.md index 1366e04b2f..44eafc84b1 100644 --- a/content/language/nodejs/_index.md +++ b/content/language/nodejs/_index.md @@ -16,4 +16,4 @@ The Node.js language-specific guide teaches you how to containerize a Node.js ap Start by containerizing an existing Node.js application. -{{< button text="Containerize a Node.js app" url="containerize.md" >}} \ No newline at end of file +{{< button text="Containerize a Node.js app" url="containerize.md" >}} diff --git a/content/language/nodejs/deploy.md b/content/language/nodejs/deploy.md index bfca397d4a..f9a8a58595 100644 --- a/content/language/nodejs/deploy.md +++ b/content/language/nodejs/deploy.md @@ -134,4 +134,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/nodejs/develop.md b/content/language/nodejs/develop.md index ed538d1e39..8c42708d45 100644 --- a/content/language/nodejs/develop.md +++ b/content/language/nodejs/develop.md @@ -25,10 +25,9 @@ You can use containers to set up local services, like a database. In this sectio 2. Uncomment the database related instructions. The following is the updated `compose.yaml` file. - > **Important** + > [!IMPORTANT] > > For this section, don't run `docker compose up` until you are instructed to. Running the command at intermediate points may incorrectly initialize your database. - { .important } ```yaml {hl_lines="26-51",collapse=true,title=compose.yaml} # Comments are provided throughout this file to help you get started. @@ -84,7 +83,7 @@ You can use containers to set up local services, like a database. In this sectio file: db/password.txt ``` - > **Note** + > [!NOTE] > > To learn more about the instructions in the Compose file, see [Compose file > reference](/compose/compose-file/). diff --git a/content/language/nodejs/run-tests.md b/content/language/nodejs/run-tests.md index cc91c53a2e..211017b384 100644 --- a/content/language/nodejs/run-tests.md +++ b/content/language/nodejs/run-tests.md @@ -170,4 +170,4 @@ Related information: Next, you’ll learn how to set up a CI/CD pipeline using GitHub Actions. -{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} \ No newline at end of file +{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} diff --git a/content/language/php/_index.md b/content/language/php/_index.md index 4bb0c3f819..c5f90fb38b 100644 --- a/content/language/php/_index.md +++ b/content/language/php/_index.md @@ -18,4 +18,4 @@ After completing the PHP language-specific guide, you should be able to containe Start by containerizing an existing PHP application. -{{< button text="Containerize a PHP app" url="containerize.md" >}} \ No newline at end of file +{{< button text="Containerize a PHP app" url="containerize.md" >}} diff --git a/content/language/php/containerize.md b/content/language/php/containerize.md index e3324c6d61..05fa5c52ed 100644 --- a/content/language/php/containerize.md +++ b/content/language/php/containerize.md @@ -127,4 +127,4 @@ Related information: In the next section, you'll learn how you can develop your application using Docker containers. -{{< button text="Develop your application" url="develop.md" >}} \ No newline at end of file +{{< button text="Develop your application" url="develop.md" >}} diff --git a/content/language/php/deploy.md b/content/language/php/deploy.md index 79ff897b3e..d7a53f8dbc 100644 --- a/content/language/php/deploy.md +++ b/content/language/php/deploy.md @@ -137,4 +137,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/php/develop.md b/content/language/php/develop.md index 22801aae2b..efc13000c2 100644 --- a/content/language/php/develop.md +++ b/content/language/php/develop.md @@ -108,7 +108,7 @@ secrets: file: db/password.txt ``` -> **Note** +> [!NOTE] > > To learn more about the instructions in the Compose file, see [Compose file > reference](/compose/compose-file/). @@ -427,4 +427,4 @@ Related information: In the next section, you'll learn how to run unit tests using Docker. -{{< button text="Run your tests" url="run-tests.md" >}} \ No newline at end of file +{{< button text="Run your tests" url="run-tests.md" >}} diff --git a/content/language/php/run-tests.md b/content/language/php/run-tests.md index e9bc69290a..fc007b0375 100644 --- a/content/language/php/run-tests.md +++ b/content/language/php/run-tests.md @@ -114,4 +114,4 @@ Related information: Next, you’ll learn how to set up a CI/CD pipeline using GitHub Actions. -{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} \ No newline at end of file +{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}} diff --git a/content/language/python/deploy.md b/content/language/python/deploy.md index 7048c1b2f9..51ae9f3fd5 100644 --- a/content/language/python/deploy.md +++ b/content/language/python/deploy.md @@ -162,7 +162,7 @@ In these Kubernetes YAML file, there are various objects, separated by the `---` To learn more about Kubernetes objects, see the [Kubernetes documentation](https://kubernetes.io/docs/home/). -> **Note** +> [!NOTE] > > * The `NodePort` service is good for development/testing purposes. For production you should implement an [ingress-controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/). @@ -250,4 +250,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/python/develop.md b/content/language/python/develop.md index 713f3a120d..3985ebc91c 100644 --- a/content/language/python/develop.md +++ b/content/language/python/develop.md @@ -377,7 +377,7 @@ secrets: file: db/password.txt ``` -> **Note** +> [!NOTE] > > To learn more about the instructions in the Compose file, see [Compose file > reference](/compose/compose-file/). diff --git a/content/language/r/develop.md b/content/language/r/develop.md index 1f36bbbbd3..8b18ce32fe 100644 --- a/content/language/r/develop.md +++ b/content/language/r/develop.md @@ -84,7 +84,7 @@ secrets: file: db/password.txt ``` -> **Note** +> [!NOTE] > > To learn more about the instructions in the Compose file, see [Compose file > reference](/compose/compose-file/). diff --git a/content/language/ruby/deploy.md b/content/language/ruby/deploy.md index 3847471302..b587a25b0d 100644 --- a/content/language/ruby/deploy.md +++ b/content/language/ruby/deploy.md @@ -159,4 +159,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/language/ruby/develop.md b/content/language/ruby/develop.md index 3738e8cd6a..18e189d898 100644 --- a/content/language/ruby/develop.md +++ b/content/language/ruby/develop.md @@ -51,7 +51,7 @@ secrets: file: db/password.txt ``` -> **Note** +> [!NOTE] > > To learn more about the instructions in the Compose file, see [Compose file > reference](/compose/compose-file/). diff --git a/content/language/rust/_index.md b/content/language/rust/_index.md index f0a468e8c6..19f9b81483 100644 --- a/content/language/rust/_index.md +++ b/content/language/rust/_index.md @@ -20,4 +20,4 @@ After completing the Rust modules, you should be able to containerize your own R Start with building your first Rust image. -{{< button text="Build your first Rust image" url="build-images.md" >}} \ No newline at end of file +{{< button text="Build your first Rust image" url="build-images.md" >}} diff --git a/content/language/rust/deploy.md b/content/language/rust/deploy.md index b1fbf482c8..c9d2e1c28e 100644 --- a/content/language/rust/deploy.md +++ b/content/language/rust/deploy.md @@ -224,4 +224,4 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) \ No newline at end of file + - [Swarm mode overview](../../engine/swarm/_index.md) diff --git a/content/scout/explore/analysis.md b/content/scout/explore/analysis.md index c731671837..27a3ccc147 100644 --- a/content/scout/explore/analysis.md +++ b/content/scout/explore/analysis.md @@ -40,7 +40,7 @@ the registry must be integrated with Docker Scout for your Docker organization. Docker Hub is integrated by default. For more information, see See [Container registry integrations](/scout/integrations/_index.md#container-registries) -> **Note** +> [!NOTE] > > You must have the **Editor** or **Owner** role in the Docker organization to > activate image analysis on a repository. @@ -60,7 +60,7 @@ To trigger image analysis for an image in a registry, push the image to a registry that's integrated with Docker Scout, to a repository where image analysis is activated. -> **Note** +> [!NOTE] > > Image analysis on the Docker Scout platform has a maximum image file size > limit of 10 GB, unless the image has an SBOM attestation. @@ -78,7 +78,7 @@ analysis is activated. [build attestations](/build/attestations/_index.md) to the image. Docker Scout uses attestations to provide more fine-grained analysis results. - > **Note** + > [!NOTE] > > The default `docker` driver only supports build attestations if you use the > [containerd image store](/desktop/containerd.md). @@ -95,7 +95,7 @@ You can analyze local images with Docker Scout using Docker Desktop or the ### Docker Desktop -> **Note** +> [!NOTE] > > Docker Desktop background indexing supports images up to 10 GB in size. > See [Maximum image size](#maximum-image-size). diff --git a/content/scout/explore/dashboard.md b/content/scout/explore/dashboard.md index e0dd1f31f5..1e1cadda8a 100644 --- a/content/scout/explore/dashboard.md +++ b/content/scout/explore/dashboard.md @@ -147,7 +147,7 @@ vulnerability is disclosed in a security advisory, and it affects one or more of your images. You will not receive notifications about changes to vulnerability exposure or policy compliance as a result of pushing a new image. -> **Note** +> [!NOTE] > > Notifications are only triggered for the *last pushed* image tags for each > repository. "Last pushed" refers to the image tag that was most recently diff --git a/content/scout/explore/exceptions.md b/content/scout/explore/exceptions.md index a824cb4103..2493460165 100644 --- a/content/scout/explore/exceptions.md +++ b/content/scout/explore/exceptions.md @@ -257,7 +257,7 @@ exception later. Image layers are immutable, so anything you put in the image's filesystem is there forever. Attaching the document as an [attestation](#attestation) provides better flexibility. -> **Note** +> [!NOTE] > > VEX documents embedded in the image filesystem are not considered for images > that have attestations. If your image has **any** attestations, Docker Scout diff --git a/content/scout/explore/metrics-exporter.md b/content/scout/explore/metrics-exporter.md index 2eb85d18d5..bde3e5f2af 100644 --- a/content/scout/explore/metrics-exporter.md +++ b/content/scout/explore/metrics-exporter.md @@ -32,7 +32,7 @@ The metrics endpoint exposes the following metrics: > > Streams is mostly an internal concept in Docker Scout, > with the exception of the data exposed through this metrics endpoint. -{ .tip #stream } +{ #stream } ## Creating an access token @@ -214,13 +214,12 @@ instances: value: Bearer ``` -> **Important** +> [!IMPORTANT] > > Do not replace the `` placeholder in the previous configuration > example. It must stay as it is. Only make sure the Docker PAT is correctly > mounted into the Datadog agent in the specified filesystem path. Save the > file as `conf.yaml` and restart the agent. -{ .important } When creating a Datadog agent configuration of your own, make sure to edit the `openmetrics_endpoint` property to target your organization, by replacing diff --git a/content/scout/guides/vex.md b/content/scout/guides/vex.md index 723b96a1d7..b72a29045b 100644 --- a/content/scout/guides/vex.md +++ b/content/scout/guides/vex.md @@ -272,7 +272,7 @@ Instead, `products` should refer to the packages that contain the vulnerabilitie 3. Analyze the image with `docker scout cves`. - > **Note** + > [!NOTE] > > This only works when analyzing remote images in a registry. > To force Docker Scout to analyze a registry image instead of a local one, diff --git a/content/scout/install.md b/content/scout/install.md index 7ab4aff94f..5ccaf19833 100644 --- a/content/scout/install.md +++ b/content/scout/install.md @@ -19,7 +19,7 @@ $ curl -fsSL https://raw.githubusercontent.com/docker/scout-cli/main/install.sh $ sh install-scout.sh ``` -> **Note** +> [!NOTE] > > Always examine scripts downloaded from the internet before running them > locally. Before installing, make yourself familiar with potential risks and diff --git a/content/scout/integrations/ci/gha.md b/content/scout/integrations/ci/gha.md index 6201efc2d1..4f4cb002d3 100644 --- a/content/scout/integrations/ci/gha.md +++ b/content/scout/integrations/ci/gha.md @@ -102,7 +102,7 @@ This creates workflow steps to: 3. Extract metadata from Git reference and GitHub events. 4. Build and push the Docker image to the registry. -> **Note** +> [!NOTE] > > This CI workflow runs a local analysis and evaluation of your image. To > evaluate the image locally, you must ensure that the image is loaded the diff --git a/content/scout/integrations/ci/jenkins.md b/content/scout/integrations/ci/jenkins.md index 52b227e482..827ec2f5e9 100644 --- a/content/scout/integrations/ci/jenkins.md +++ b/content/scout/integrations/ci/jenkins.md @@ -41,7 +41,7 @@ This installs Docker Scout, logs into Docker Hub, and then runs Docker Scout to generate a CVE report for an image and tag. It only shows critical or high-severity vulnerabilities. -> **Note** +> [!NOTE] > > If you're seeing a `permission denied` error related to the image cache, try > setting the [`DOCKER_SCOUT_CACHE_DIR`](/scout/how-tos/configure-cli.md) environment diff --git a/content/scout/integrations/code-quality/sonarqube.md b/content/scout/integrations/code-quality/sonarqube.md index 7335c61a50..decc74e119 100644 --- a/content/scout/integrations/code-quality/sonarqube.md +++ b/content/scout/integrations/code-quality/sonarqube.md @@ -21,7 +21,7 @@ of the SonarQube analysis record corresponding to the image. Docker Scout uses Git provenance metadata on the images, from provenance attestations or an OCI annotations, to link image repositories with SonarQube analysis results. -> **Note** +> [!NOTE] > > Docker Scout doesn't have access to historic SonarQube analysis records. Only > analysis results recorded after the integration is enabled will be available diff --git a/content/scout/integrations/environment/_index.md b/content/scout/integrations/environment/_index.md index f0742ef05b..cb61af1d2b 100644 --- a/content/scout/integrations/environment/_index.md +++ b/content/scout/integrations/environment/_index.md @@ -39,7 +39,7 @@ Docker Scout supports the following runtime integrations: - [CLI client](./cli.md) - [Sysdig integration](./sysdig.md) -> **Note** +> [!NOTE] > > Only organization owners can create new environments and set up integrations. > Additionally, Docker Scout only assigns an image to an environment if the diff --git a/content/scout/integrations/environment/sysdig.md b/content/scout/integrations/environment/sysdig.md index 26eb65ad93..fa03f72c54 100644 --- a/content/scout/integrations/environment/sysdig.md +++ b/content/scout/integrations/environment/sysdig.md @@ -18,12 +18,11 @@ integrates with the Sysdig API to discover the images in your cluster. This integration uses Sysdig's Risk Spotlight feature. For more information, see [Risk Spotlight Integrations (Sysdig docs)](https://docs.sysdig.com/en/docs/sysdig-secure/integrations-for-sysdig-secure/risk-spotlight-integrations/). -> **Tip** +> [!TIP] > > Sysdig offers a free trial for Docker users to try out the new Docker Scout integration. > > {{< button url=`https://sysdig.com/free-trial-for-docker-customers/` text="Sign up" >}} -{ .tip } Each Sysdig integration maps to an environment. When you enable a Sysdig integration, you specify the environment name for that cluster, such as @@ -90,7 +89,7 @@ running in the cluster, and assigns those images to the environment associated with the cluster. For more information about environments, see [Environment monitoring](./_index.md). -> **Note** +> [!NOTE] > > Docker Scout only detects images that have been analyzed. To trigger an image > analysis, enable a [registry integration](../_index.md#container-registries) diff --git a/content/scout/integrations/registry/acr.md b/content/scout/integrations/registry/acr.md index e037d9e7c9..911ba9620f 100644 --- a/content/scout/integrations/registry/acr.md +++ b/content/scout/integrations/registry/acr.md @@ -32,7 +32,7 @@ Docker Scout pulls and analyzes the latest image version automatically. The following table describes the configuration resources. -> **Note** +> [!NOTE] > > Creating these resources incurs a small, recurring cost on the Azure account. > The **Cost** column in the table represents an estimated monthly cost of the @@ -118,11 +118,10 @@ latest image version automatically. ## Remove an integration -> **Important** +> [!IMPORTANT] > > Removing the integration in the Docker Scout Dashboard doesn't automatically > remove the resources created in Azure. -{ .important } To remove an ACR integration: diff --git a/content/scout/integrations/registry/artifactory.md b/content/scout/integrations/registry/artifactory.md index 693e2f1b9a..4a5b0c4389 100644 --- a/content/scout/integrations/registry/artifactory.md +++ b/content/scout/integrations/registry/artifactory.md @@ -17,11 +17,10 @@ You can analyze Artifactory images for vulnerabilities locally using Docker Desk docker login {URL} ``` -> **Tip** +> [!TIP] > > For cloud-hosted Artifactory you can find the credentials for your Artifactory repository by > selecting it in the Artifactory UI and then the **Set Me Up** button. -{ .tip } ## Remote image analysis @@ -142,11 +141,10 @@ the container. Make sure the mount path you use is the directory containing the `config.json` file. -> **Important** +> [!IMPORTANT] > > Use the `v1` tag of the Artifactory agent image. Don't use the `latest` tag as > doing so may incur breaking changes. -{ .important } ```console $ docker run \ diff --git a/content/scout/integrations/registry/ecr.md b/content/scout/integrations/registry/ecr.md index 99306ac838..b81c17cc53 100644 --- a/content/scout/integrations/registry/ecr.md +++ b/content/scout/integrations/registry/ecr.md @@ -32,7 +32,7 @@ themselves. For more information about how Docker Scout handles image data, see The following table describes the configuration resources. -> **Note** +> [!NOTE] > > Creating these resources incurs a small, recurring cost on the AWS account. > The **Cost** column in the table represents an estimated monthly cost of the @@ -133,7 +133,7 @@ organization. 3. In the dialog that opens, confirm by selecting **Remove**. -> **Important** +> [!IMPORTANT] > > Removing the integration from the Docker Scout dashboard doesn't remove the > AWS resources in your account. @@ -141,7 +141,6 @@ organization. > After removing the integration in Docker Scout, go to the AWS console and > delete the **DockerScoutECRIntegration** CloudFormation stack for the integration > that you want to remove. -{ .important } ## Troubleshooting diff --git a/content/scout/integrations/team-collaboration/slack.md b/content/scout/integrations/team-collaboration/slack.md index 3844718802..9e5c5ccf8b 100644 --- a/content/scout/integrations/team-collaboration/slack.md +++ b/content/scout/integrations/team-collaboration/slack.md @@ -19,7 +19,7 @@ After configuring the integration, Docker Scout sends notifications about changes to policy compliance and vulnerability exposure for your repositories, to the Slack channels associated with the webhook. -> **Note** +> [!NOTE] > > Notifications are only triggered for the *last pushed* image tags for each > repository. "Last pushed" refers to the image tag that was most recently diff --git a/content/scout/policy/_index.md b/content/scout/policy/_index.md index 5f0146fe24..3f7cca72eb 100644 --- a/content/scout/policy/_index.md +++ b/content/scout/policy/_index.md @@ -207,7 +207,7 @@ USER root RUN echo "Hi" ``` -> **Note** +> [!NOTE] > > This policy only checks for the default user of the image, as set in the > image configuration blob. Even if you do specify a non-root default user, @@ -342,7 +342,7 @@ Once you push an image and policy evaluation completes, the results from the SonarQube quality gates display as a policy in the Docker Scout Dashboard, and in the CLI. -> **Note** +> [!NOTE] > > Docker Scout can only access SonarQube analyses created after the integration > is enabled. Docker Scout doesn't have access to historic evaluations. Trigger diff --git a/content/scout/policy/ci.md b/content/scout/policy/ci.md index b3eacb2758..bdd41f761f 100644 --- a/content/scout/policy/ci.md +++ b/content/scout/policy/ci.md @@ -56,7 +56,7 @@ registry. As a result, this workflow uses the `docker/login-action` twice: If you use Docker Hub as your container registry, you only need to authenticate once. -> **Note** +> [!NOTE] > > Due to a limitation in the Docker Engine, loading multi-platform images or > images with attestations to the image store isn't supported. diff --git a/content/scout/quickstart.md b/content/scout/quickstart.md index fd56ccfa8e..a328e1ac99 100644 --- a/content/scout/quickstart.md +++ b/content/scout/quickstart.md @@ -231,7 +231,7 @@ The images page lists your Scout-enabled repositories. Select the image in the list to open the **Image details** sidebar. The sidebar shows a compliance overview for the last pushed tag of a repository. -> **Note** +> [!NOTE] > > If policy results haven't appeared yet, try refreshing the page. > It might take a few minutes before the results appear if this is your @@ -248,12 +248,11 @@ In this case, the recommended action is to enable [Docker Scout's GitHub integration](./integrations/source-code-management/github.md), which helps keep your base images up-to-date automatically. -> **Tip** +> [!TIP] > > You can't enable this integration for the demo app used in this guide. > Feel free to push the code to a GitHub repository that you own, > and try out the integration there! -{ .tip } ## Summary diff --git a/content/scout/release-notes/cli.md b/content/scout/release-notes/cli.md index d115ee9592..e387114259 100644 --- a/content/scout/release-notes/cli.md +++ b/content/scout/release-notes/cli.md @@ -305,7 +305,7 @@ Discarded in favor of [1.9.1](#191). {{< release-date date="2024-03-20" >}} -> **Note** +> [!NOTE] > > This release only affects the `docker/scout-action` GitHub Action. @@ -333,7 +333,7 @@ Discarded in favor of [1.9.1](#191). {{< release-date date="2024-03-19" >}} -> **Note** +> [!NOTE] > > This release only affects the CLI plugin, not the GitHub Action diff --git a/content/security/for-admins/domain-audit.md b/content/security/for-admins/domain-audit.md index a4999b4748..4295de3e2a 100644 --- a/content/security/for-admins/domain-audit.md +++ b/content/security/for-admins/domain-audit.md @@ -19,7 +19,7 @@ Domain audit can't identify the following Docker users in your environment: Although domain audit can't identify all Docker users in your environment, you can enforce sign-in to prevent unidentifiable users from accessing Docker Desktop in your environment. For more details about enforcing sign-in, see [Configure registry.json to enforce sign-in](../for-admins/enforce-sign-in/_index.md). -> **Tip** +> [!TIP] > > You can use endpoint management (MDM) software to identify the number of Docker Desktop instances and their versions within your environment. This can provide accurate license reporting, help ensure your machines use the latest version of Docker Desktop, and enable you to [enforce sign-in](enforce-sign-in/_index.md). > - [Intune](https://learn.microsoft.com/en-us/mem/intune/apps/app-discovered-apps) @@ -27,7 +27,6 @@ Although domain audit can't identify all Docker users in your environment, you c > - [Kandji](https://support.kandji.io/support/solutions/articles/72000559793-view-a-device-application-list) > - [Kolide](https://www.kolide.com/features/device-inventory/properties/mac-apps) > - [Workspace One](https://blogs.vmware.com/euc/2022/11/how-to-use-workspace-one-intelligence-to-manage-app-licenses-and-reduce-costs.html) -{ .tip } ## Prerequisites @@ -36,10 +35,9 @@ Before you audit your domains, review the following required prerequisites: - Your organization must be part of a Docker Business subscription. To upgrade your existing account to a Docker Business subscription, see [Upgrade your subscription](../../subscription/core-subscription/upgrade.md). - You must [add and verify your domains](./single-sign-on/configure/_index.md#step-one-add-and-verify-your-domain). -> **Important** +> [!IMPORTANT] > > Domain audit is not supported for companies or organizations within a company. -{ .important } ## Audit your domains for uncaptured users diff --git a/content/security/for-admins/enforce-sign-in/_index.md b/content/security/for-admins/enforce-sign-in/_index.md index 654025803e..b1adf05ffc 100644 --- a/content/security/for-admins/enforce-sign-in/_index.md +++ b/content/security/for-admins/enforce-sign-in/_index.md @@ -41,4 +41,3 @@ following occurs: > This means that your users must use SSO to sign in, instead of a username and password. > When you enforce sign-in and enforce SSO, your users must sign in and must use SSO to do so. > See [Enforce SSO](/security/for-admins/single-sign-on/connect#optional-enforce-sso) for details on how to enable this for your SSO connection. -{ .tip } diff --git a/content/security/for-admins/enforce-sign-in/methods.md b/content/security/for-admins/enforce-sign-in/methods.md index a3fb8b3b3d..de1c08a4a8 100644 --- a/content/security/for-admins/enforce-sign-in/methods.md +++ b/content/security/for-admins/enforce-sign-in/methods.md @@ -20,10 +20,9 @@ This page outlines the different ways you can enforce sign-in for Docker Desktop $ HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Docker\Docker Desktop ``` 2. Create a multi-string value `allowedOrgs`. - > **Important** + > [!IMPORTANT] > > Only one entry for `allowedOrgs` is currently supported. If you add more than one value, sign-in enforcement silently fails. - { .important } 3. As string data use your organization’s name, all lowercase. 4. Restart Docker Desktop. 5. Open Docker Desktop and when Docker Desktop starts, verify that the **Sign in required!** prompt appears. @@ -72,10 +71,9 @@ There are many ways to deploy the registry key, for example using an MDM solutio ``` - > **Important** + > [!IMPORTANT] > > Only one entry for `allowedOrgs` is currently supported. If you add more than one value, sign-in enforcement silently fails. - { .important } 3. Modify the file permissions to ensure the file cannot be edited by any non-administrator users. 4. Restart Docker Desktop. @@ -148,10 +146,9 @@ details, see [Manage members](/admin/organization/members/). "allowedOrgs": ["myorg"] } ``` - > **Important** + > [!IMPORTANT] > > Only one entry for `allowedOrgs` is currently supported. If you add more than one value, sign-in enforcement silently fails. - { .important } 4. Verify that sign-in is enforced. @@ -160,10 +157,9 @@ details, see [Manage members](/admin/organization/members/). In some cases, a system reboot may be necessary for the enforcement to take effect. - > **Tip** + > [!TIP] > > If your users have issues starting Docker Desktop after you enforce sign-in, they may need to update to the latest version. - { .tip } ### Option 2: Create a registry.json file when installing Docker Desktop diff --git a/content/security/for-admins/hardened-desktop/_index.md b/content/security/for-admins/hardened-desktop/_index.md index e0cc2b0335..b2756b47ba 100644 --- a/content/security/for-admins/hardened-desktop/_index.md +++ b/content/security/for-admins/hardened-desktop/_index.md @@ -29,7 +29,7 @@ grid: link: /security/for-admins/hardened-desktop/air-gapped-containers/ --- -> **Note** +> [!NOTE] > > Hardened Docker Desktop is available to Docker Business customers only. diff --git a/content/security/for-admins/hardened-desktop/air-gapped-containers.md b/content/security/for-admins/hardened-desktop/air-gapped-containers.md index 21568f826b..c202414d4b 100644 --- a/content/security/for-admins/hardened-desktop/air-gapped-containers.md +++ b/content/security/for-admins/hardened-desktop/air-gapped-containers.md @@ -49,10 +49,9 @@ The `containersProxy` setting describes the policy which is applied to traffic f - `pac` : URL for a PAC file. Only takes effect if `mode` is `manual`, and is considered higher priority than `http`, `https`, `exclude`. - `transparentPorts`: A comma-separated list of ports (e.g. `"80,443,8080"`) or a wildcard (`*`) indicating which ports should be proxied. -> **Important** +> [!IMPORTANT] > > Any existing `proxy` setting in the `admin-settings.json` file continues to apply to traffic from the app on the host. -{ .important } ## Example PAC file diff --git a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md index 61e325603d..3b6dd0df40 100644 --- a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md +++ b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md @@ -7,7 +7,7 @@ aliases: - /desktop/hardened-desktop/enhanced-container-isolation/ --- -> **Note** +> [!NOTE] > > Enhanced Container Isolation is available to Docker Business customers only. @@ -25,7 +25,7 @@ When Enhanced Container Isolation is enabled, these mechanisms are applied autom Enhanced Container Isolation ensures stronger container isolation and also locks in any security configurations that have been created by IT admins, for instance through [Registry Access Management policies](/security/for-admins/hardened-desktop/registry-access-management.md) or with [Settings Management](../settings-management/index.md). -> **Note** +> [!NOTE] > > Enhanced Container Isolation is in addition to other container security techniques used by Docker. For example, reduced Linux Capabilities, Seccomp, AppArmor. @@ -57,12 +57,11 @@ These features and restrictions ensure that containers are better secured at run For more information on how Enhanced Container Isolation work, see [How does it work](how-eci-works.md). -> **Important** +> [!IMPORTANT] > > Enhanced Container Isolation does not yet fully protect Docker builds, > Kubernetes pods and Extension containers. For more information on known > limitations and workarounds, see [FAQs](faq.md). -{.important } ### What host OSes / platforms is Enhanced Container Isolation supported on? @@ -87,10 +86,9 @@ To enable Enhanced Container Isolation as a developer: 5. Next to **Use Enhanced Container Isolation**, select the checkbox. 6. Select **Apply and restart** to save your settings. -> **Important** +> [!IMPORTANT] > > Enhanced Container Isolation does not protect containers created prior to enabling ECI. For more information on known limitations and workarounds, see [FAQs](faq.md). -{ .important } #### As an admin @@ -131,10 +129,9 @@ For this to take effect: - On a new install, developers need to launch Docker Desktop and authenticate to their organization. - On an existing install, developers need to quit Docker Desktop through the Docker menu, and then relaunch Docker Desktop. If they are already signed in, they don’t need to sign in again for the changes to take effect. -> **Important** +> [!IMPORTANT] > > Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop. -{ .important } ### What do users see when this setting is enforced by an admin? diff --git a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md index e6aa5a26dc..205d495312 100644 --- a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md +++ b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md @@ -6,7 +6,7 @@ aliases: - /desktop/hardened-desktop/enhanced-container-isolation/config/ --- -> **Note** +> [!NOTE] > > This feature is available with Docker Desktop version 4.27 (and later) on Mac, Linux, and Windows (Hyper-V). > For Windows with WSL 2, this feature requires Docker Desktop 4.28 and later. @@ -101,10 +101,9 @@ $ docker run -it -v /var/run/docker.sock:/var/run/docker.sock docker:cli sh / # ``` -> **Tip** +> [!TIP] > > Be restrictive on the images you allow, as described in [Recommendations](#recommendations) below. -{ .tip } In general, it's easier to specify the image using the tag wildcard format (e.g., `:*`) because then `imageList` doesn't need to be updated whenever a new version of the @@ -257,7 +256,7 @@ Whether to configure the list as an allow or deny list depends on the use case. | scout | Docker Scout | | trust | Manage trust on Docker images | -> **Note** +> [!NOTE] > > Docker socket mount permissions do not apply when running "true" > Docker-in-Docker (i.e., when running the Docker Engine inside a container). In diff --git a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/features-benefits.md b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/features-benefits.md index 3b553d6820..f8def79f12 100644 --- a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/features-benefits.md +++ b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/features-benefits.md @@ -68,7 +68,7 @@ this. The combination of the Linux user-namespace and other security techniques used by Sysbox ensures that processes inside a privileged container can only access resources assigned to the container. -> **Note** +> [!NOTE] > > Enhanced Container Isolation does not prevent users from launching privileged > containers, but rather runs them securely by ensuring that they can only @@ -169,7 +169,7 @@ $ docker run -it --rm -v $HOME:/mnt alpine / # ``` -> **Note** +> [!NOTE] > > By default, Enhanced Container Isolation won't allow bind mounting the Docker Engine socket > (/var/run/docker.sock) into a container, as doing so essentially grants the diff --git a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/how-eci-works.md b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/how-eci-works.md index 87ac7ef1d3..10bc1b3d7d 100644 --- a/content/security/for-admins/hardened-desktop/enhanced-container-isolation/how-eci-works.md +++ b/content/security/for-admins/hardened-desktop/enhanced-container-isolation/how-eci-works.md @@ -24,7 +24,7 @@ Even containers that use the insecure `--privileged` flag can now be run securely with Enhanced Container Isolation, such that they can no longer be used to breach the Docker Desktop Virtual Machine (VM) or other containers. -> **Note** +> [!NOTE] > > When Enhanced Container Isolation is enabled in Docker Desktop, the Docker CLI > "--runtime" flag is ignored. Docker's default runtime continues to be "runc", diff --git a/content/security/for-admins/hardened-desktop/image-access-management.md b/content/security/for-admins/hardened-desktop/image-access-management.md index 80906c484d..c38ea71f92 100644 --- a/content/security/for-admins/hardened-desktop/image-access-management.md +++ b/content/security/for-admins/hardened-desktop/image-access-management.md @@ -9,7 +9,7 @@ aliases: - /security/for-admins/image-access-management/ --- -> **Note** +> [!NOTE] > > Image Access Management is available to [Docker Business](/subscription/core-subscription/details.md#docker-business) customers only. diff --git a/content/security/for-admins/hardened-desktop/registry-access-management.md b/content/security/for-admins/hardened-desktop/registry-access-management.md index 00ddfc5cba..e66bcdd9e4 100644 --- a/content/security/for-admins/hardened-desktop/registry-access-management.md +++ b/content/security/for-admins/hardened-desktop/registry-access-management.md @@ -9,7 +9,7 @@ aliases: - /security/for-admins/registry-access-management/ --- -> **Note** +> [!NOTE] > > Registry Access Management is available to [Docker Business](/subscription/core-subscription/details.md) customers only. diff --git a/content/security/for-admins/hardened-desktop/settings-management/configure.md b/content/security/for-admins/hardened-desktop/settings-management/configure.md index a5a0bb550e..e3ed6c79e6 100644 --- a/content/security/for-admins/hardened-desktop/settings-management/configure.md +++ b/content/security/for-admins/hardened-desktop/settings-management/configure.md @@ -41,10 +41,9 @@ To set it up manually: By placing this file in the above protected directories, end users are unable to modify it. - > **Important** + > [!IMPORTANT] > > It is assumed that you have the ability to push the `admin-settings.json` settings file to the locations specified above through a device management software such as [Jamf](https://www.jamf.com/lp/en-gb/apple-mobile-device-management-mdm-jamf-shared/?attr=google_ads-brand-search-shared&gclid=CjwKCAjw1ICZBhAzEiwAFfvFhEXjayUAi8FHHv1JJitFPb47C_q_RCySTmF86twF1qJc_6GST-YDmhoCuJsQAvD_BwE). - { .important } ### Step two: Configure the settings you want to lock in @@ -233,7 +232,6 @@ For settings to take effect: >**Important** > >Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop. - { .important } Docker doesn't automatically mandate that developers re-launch and sign in once a change has been made so as not to disrupt your developers' workflow. diff --git a/content/security/for-admins/provisioning/group-mapping.md b/content/security/for-admins/provisioning/group-mapping.md index 3aeb12e5ee..283f08ae04 100644 --- a/content/security/for-admins/provisioning/group-mapping.md +++ b/content/security/for-admins/provisioning/group-mapping.md @@ -11,10 +11,9 @@ aliases: With directory group-to-team provisioning from your IdP, user updates will automatically sync with your Docker organizations and teams. You can use group mapping once you have configured [single sign-on (SSO)](../single-sign-on/_index.md). -> **Tip** +> [!TIP] > > Group mapping is ideal for adding a user to multiple organizations or multiple teams within one organization. If you don't need to set up multi-organization or multi-team assignment, you can use [user-level attributes](scim.md#set-up-role-mapping). -{ .tip } ## How group mapping works @@ -33,7 +32,6 @@ You can use this format to add a user to multiple organizations. For example, if >**Tip** > >Use the same names for the Docker teams as your group names in the IdP to prevent further configuration. When you sync groups, this creates a group if it doesn’t already exist. -{ .tip} The following lists the supported group mapping attributes: @@ -168,10 +166,9 @@ To verify, go to **Monitor > Provisioning logs** to see that your groups were pr Once complete, a user who signs in to Docker through SSO is automatically added to the organizations and teams mapped in the IdP. -> **Tip** +> [!TIP] > > [Enable SCIM](scim.md) to take advantage of automatic user provisioning and de-provisioning. If you don't enable SCIM users are only automatically provisioned. You have to de-provision them manually. -{ .tip } ## More resources diff --git a/content/security/for-admins/provisioning/just-in-time.md b/content/security/for-admins/provisioning/just-in-time.md index cb64d3341d..75076b741b 100644 --- a/content/security/for-admins/provisioning/just-in-time.md +++ b/content/security/for-admins/provisioning/just-in-time.md @@ -53,9 +53,8 @@ You may want to disable JIT provisioning for reasons such as the following: - You have multiple organizations, have SCIM enabled, and want SCIM to be the source of truth for provisioning - You want to control and restrict usage based on your organization's security configuration, and want to use SCIM to provision access -> **Warning** +> [!WARNING] > > Disabling JIT provisioning could potentially disrupt your users' workflows. Users must already be a member of the organization or have an invitation to the organization when they authenticate with SSO in order to sign in successfully. To auto-provision users with JIT disabled, you can [use SCIM](./scim.md). -{ .warning } -See [Manage how users are provisioned](../single-sign-on/manage/_index.md#manage-how-users-are-provisioned) to learn how to disable JIT provisioning. \ No newline at end of file +See [Manage how users are provisioned](../single-sign-on/manage/_index.md#manage-how-users-are-provisioned) to learn how to disable JIT provisioning. diff --git a/content/security/for-admins/provisioning/scim.md b/content/security/for-admins/provisioning/scim.md index c8397bf75c..a33f71e522 100644 --- a/content/security/for-admins/provisioning/scim.md +++ b/content/security/for-admins/provisioning/scim.md @@ -40,15 +40,13 @@ The following table lists the supported attributes. Note that your attribute map For additional details about supported attributes and SCIM, see [Docker Hub API SCIM reference](/docker-hub/api/latest/#tag/scim). -> **Important** +> [!IMPORTANT] > > SSO uses Just-in-Time (JIT) provisioning by default. If you [enable SCIM](scim.md#set-up-scim), JIT values still overwrite the attribute values set by SCIM provisioning whenever users log in. To avoid conflicts, make sure your JIT values match your SCIM values. For more information, see [SSO attributes](../single-sign-on/configure/configure-idp.md#sso-attributes). -{.important} -> **Tip** +> [!TIP] > > Optional Just-in-Time (JIT) provisioning is available when you use the Admin Console and enable SCIM. With this feature, you can avoid conflicts between SCIM and JIT by disabling JIT provisioning in your SSO connection. See [SSO authentication with JIT provisioning disabled](/security/for-admins/provisioning/just-in-time/#sso-authentication-with-jit-provisioning-disabled). -{ .tip } ## Enable SCIM in Docker @@ -132,7 +130,7 @@ See the documentation for your IdP for additional details: You can assign [roles](/security/for-admins/roles-and-permissions/) to members in your organization in the IdP. To set up a role, you can use optional user-level attributes for the person you want to assign a role. In addition to roles, you can set an organization or team to override the default provisioning values set by the SSO connection. -> **Note** +> [!NOTE] > > These mappings are supported for both SCIM and JIT provisioning. With JIT provisioning, role mapping only applies when a user is initially provisioned to the organization. diff --git a/content/security/for-admins/single-sign-on/configure/configure-idp.md b/content/security/for-admins/single-sign-on/configure/configure-idp.md index eae19748c0..8d6913b075 100644 --- a/content/security/for-admins/single-sign-on/configure/configure-idp.md +++ b/content/security/for-admins/single-sign-on/configure/configure-idp.md @@ -36,15 +36,13 @@ When a user signs in using SSO, Docker obtains the following attributes from the If you use SAML for your SSO connection, Docker obtains these attributes from the SAML assertion message. Your IdP may use different naming for SAML attributes than those in the previous list. The following table lists the possible SAML attributes that can be present in order for your SSO connection to work. -> **Important** +> [!IMPORTANT] > >SSO uses Just-in-Time (JIT) provisioning by default. If you [enable SCIM](../../provisioning/scim.md), JIT values still overwrite the attribute values set by SCIM provisioning whenever users log in. To avoid conflicts, make sure your JIT values match your SCIM values. For example, to make sure that the full name of a user displays in your organization, you would set a `name` attribute in your SAML attributes and ensure the value includes their first name and last name. The exact method for setting these values (for example, constructing it with `user.firstName + " " + user.lastName`) varies depending on your IdP. -{.important} -> **Tip** +> [!TIP] > > Optional Just-in-Time (JIT) provisioning is available when you use the Admin Console and enable SCIM. With this feature, you can avoid conflicts between SCIM and JIT by disabling JIT provisioning in your SSO connection. See [SSO authentication with JIT provisioning disabled](/security/for-admins/provisioning/just-in-time/#sso-authentication-with-jit-provisioning-disabled). -{ .tip } You can also configure attributes to override default values, such as default team or organization. See [role mapping](../../provisioning/scim.md#set-up-role-mapping). @@ -57,10 +55,9 @@ You can also configure attributes to override default values, such as default te | Docker Team (optional) | `dockerTeam` | | Docker Role (optional) | `dockerRole` | -> **Important** +> [!IMPORTANT] > > If none of the email address attributes listed in the previous table are found, SSO returns an error. Also, if the `Full name` attribute isn't set, then the name will be displayed as the value of the `Email address`. -{ .important} ## Step three: Configure your IdP to work with Docker @@ -96,12 +93,11 @@ See [More resources](#more-resources) for a video overview on how to set up SSO {{< /tab >}} {{< tab name="Entra ID SAML 2.0" >}} -> **Tip** +> [!TIP] > > When you create the application for your SSO connection in Entra ID (formerly Azure AD) we recommend that you don't assign the app to all the users in the directory. > Instead, you can create a security group and assign the app to the group. This way, you can control who in your organization has access to Docker. > To change the default setting for assignment, go to the main properties for your app and find the **Assignment required** setting. Set it to **Yes**. -{ .tip } See [More resources](#more-resources) for a video overview on how to set up SSO with SAML in Entra ID (formerly Azure AD). diff --git a/content/security/for-admins/single-sign-on/manage/_index.md b/content/security/for-admins/single-sign-on/manage/_index.md index 1844a4c5e8..0ecf1ae75e 100644 --- a/content/security/for-admins/single-sign-on/manage/_index.md +++ b/content/security/for-admins/single-sign-on/manage/_index.md @@ -9,7 +9,7 @@ aliases: ## Manage organizations -> **Note** +> [!NOTE] > > You must have a [company](/admin/company/) to manage more than one organization. diff --git a/content/security/for-developers/2fa/_index.md b/content/security/for-developers/2fa/_index.md index 3a73872926..d9977978e0 100644 --- a/content/security/for-developers/2fa/_index.md +++ b/content/security/for-developers/2fa/_index.md @@ -35,4 +35,4 @@ Authenticator with a registered YubiKey. 8. Select **Enable 2FA**. Two-factor authentication is now enabled. The next time you sign -in to your Docker account, you will need to enter a security code. \ No newline at end of file +in to your Docker account, you will need to enter a security code. diff --git a/content/security/for-developers/2fa/disable-2fa.md b/content/security/for-developers/2fa/disable-2fa.md index 818dea2afa..5cd5f89668 100644 --- a/content/security/for-developers/2fa/disable-2fa.md +++ b/content/security/for-developers/2fa/disable-2fa.md @@ -7,11 +7,10 @@ aliases: - /docker-hub/2fa/disable-2fa/ --- -> **Warning** +> [!WARNING] > > Disabling two-factor authentication results in decreased security for your > Docker account. -{ .warning } 1. Sign in to your [Docker account](https://app.docker.com/login). 2. Select your avatar and then from the drop-down menu, select **Account settings**. diff --git a/content/security/for-developers/2fa/new-recovery-code.md b/content/security/for-developers/2fa/new-recovery-code.md index 2de6424cb5..d9b0ecd7f1 100644 --- a/content/security/for-developers/2fa/new-recovery-code.md +++ b/content/security/for-developers/2fa/new-recovery-code.md @@ -17,4 +17,4 @@ access to your Docker Hub account, you can generate a new recovery code. 5. Select **Generate new code**. This generates a new code. Select the visibility icon to view the code. Remember to save your recovery code -and store it somewhere safe. \ No newline at end of file +and store it somewhere safe. diff --git a/content/security/for-developers/2fa/recover-hub-account.md b/content/security/for-developers/2fa/recover-hub-account.md index c484f4d995..26748516fc 100644 --- a/content/security/for-developers/2fa/recover-hub-account.md +++ b/content/security/for-developers/2fa/recover-hub-account.md @@ -12,4 +12,4 @@ If you have lost access to both your two-factor authentication application and y 1. Sign in to your [Docker account](https://app.docker.com/login) with your username and password. 2. Select **I've lost my authentication device** and **I've lost my recovery code**. 3. Complete the [Contact Support form](https://hub.docker.com/support/contact/?category=2fa-lockout). - You must enter the primary email address associated with your Docker ID in the **Contact Support** form for recovery instructions. \ No newline at end of file + You must enter the primary email address associated with your Docker ID in the **Contact Support** form for recovery instructions. diff --git a/content/security/for-developers/access-tokens.md b/content/security/for-developers/access-tokens.md index 91a009fb7f..82f1726582 100644 --- a/content/security/for-developers/access-tokens.md +++ b/content/security/for-developers/access-tokens.md @@ -19,10 +19,9 @@ any time. ## Create an access token -> **Important** +> [!IMPORTANT] > > Treat access tokens like your password and keep them secret. Store your tokens securely in a credential manager for example. -{ .important } 1. Sign in to your [Docker account](https://app.docker.com/login). @@ -55,7 +54,7 @@ $ docker login --username When prompted for a password, enter your personal access token instead of a password. -> **Note** +> [!NOTE] > > If you have [two-factor authentication (2FA)](2fa/index.md) enabled, you must > use a personal access token when logging in from the Docker CLI. 2FA is an @@ -81,4 +80,4 @@ You can rename, activate, deactivate, or delete a token as needed. You can manag When you sign in to your Docker account with Docker Desktop, Docker Desktop generates an authentication token on your behalf. When you interact with Docker Hub using the Docker CLI, the CLI uses this token for authentication. The token scope has Read, Write, and Delete access. If your Docker Desktop session expires, the token is automatically removed locally. -You can have up to 5 auto-generated tokens associated with your account. These are deleted and created automatically based on usage and creation dates. You can also delete your auto-generated tokens as needed. See [Modify existing tokens](#modify-existing-tokens). \ No newline at end of file +You can have up to 5 auto-generated tokens associated with your account. These are deleted and created automatically based on usage and creation dates. You can also delete your auto-generated tokens as needed. See [Modify existing tokens](#modify-existing-tokens). diff --git a/content/security/security-announcements.md b/content/security/security-announcements.md index b218557367..0b62639959 100644 --- a/content/security/security-announcements.md +++ b/content/security/security-announcements.md @@ -174,7 +174,6 @@ vulnerable versions. > [CVE-2021-45046](https://nvd.nist.gov/vuln/detail/CVE-2021-45046) and > [CVE-2021-45105](https://nvd.nist.gov/vuln/detail/CVE-2021-45105). > For a more complete fix to this vulnerability, we recommended that you update to 2.17.0 where possible. -{ .important } ### Scan images on Docker Hub @@ -206,7 +205,7 @@ vulnerable for other reasons. We recommend that you also review the guidelines p | [sonarqube](https://hub.docker.com/_/sonarqube) | 8.9.5, 9.2.2 | [SonarQube announcement](https://community.sonarsource.com/t/sonarqube-sonarcloud-and-the-log4j-vulnerability/54721) | | [storm](https://hub.docker.com/_/storm) | Awaiting info | Awaiting info | -> **Note** +> [!NOTE] > > Although [xwiki](https://hub.docker.com/_/xwiki) images may be detected as vulnerable by some scanners, the authors believe the images are not vulnerable by Log4j 2 diff --git a/content/subscription/build-cloud/manage-seats.md b/content/subscription/build-cloud/manage-seats.md index c45ebfa6de..de3599c277 100644 --- a/content/subscription/build-cloud/manage-seats.md +++ b/content/subscription/build-cloud/manage-seats.md @@ -6,7 +6,7 @@ keywords: subscription, team, business, features, build, cloud, Build Cloud, rem You can add seats and manage invitations to your Docker Build Cloud Team in the Docker Build Cloud dashboard. -> **Note** +> [!NOTE] > >If you have a Docker Build Cloud Business subscription, you can add and remove seats by working with your account executive, then assign your purchased seats in the Docker Build Cloud dashboard. diff --git a/content/subscription/core-subscription/add-seats.md b/content/subscription/core-subscription/add-seats.md index ffbe92afce..03a17b5bc6 100644 --- a/content/subscription/core-subscription/add-seats.md +++ b/content/subscription/core-subscription/add-seats.md @@ -16,7 +16,6 @@ When you add seats to your subscription in the middle of your billing cycle, you >**Important** > >If you have a [sales-assisted Docker Business subscription](details.md#sales-assisted), contact your account manager to add seats to your subscription. -{ .important } 1. Sign in to your [Docker Hub](https://hub.docker.com) account. diff --git a/content/subscription/core-subscription/downgrade.md b/content/subscription/core-subscription/downgrade.md index 7a70177bc9..72be761bd7 100644 --- a/content/subscription/core-subscription/downgrade.md +++ b/content/subscription/core-subscription/downgrade.md @@ -12,10 +12,9 @@ You can downgrade your Docker subscription at anytime before the renewal date. T When you downgrade your subscription, access to paid features is available until the next billing cycle. The downgrade takes effect on the next billing cycle. -> **Important** +> [!IMPORTANT] > > If you downgrade your personal account from a Pro subscription to a Personal subscription, note that [Personal subscriptions](details.md#docker-personal) don't include collaborators for private repositories, and only 1 private repository is included. When you downgrade, all collaborators will be removed and additional private repositories are locked. -{ .important } ## Before you downgrade @@ -34,7 +33,6 @@ If you want to downgrade a Docker Business subscription and your organization us >**Important** > >If you have a [sales-assisted Docker Business subscription](details.md#sales-assisted), contact your account manager to downgrade your subscription. -{ .important } 1. Sign in to your [Docker Hub](https://hub.docker.com) account. diff --git a/content/subscription/core-subscription/remove-seats.md b/content/subscription/core-subscription/remove-seats.md index 80d89a0bf2..283b7fe0ff 100644 --- a/content/subscription/core-subscription/remove-seats.md +++ b/content/subscription/core-subscription/remove-seats.md @@ -18,7 +18,6 @@ For example, if you receive your billing on the 8th of every month for 10 seats >**Important** > >If you have a [sales-assisted Docker Business subscription](details.md#sales-assisted), contact your account manager to remove seats from your subscription. -{ .important } 1. Sign in to your [Docker Hub](https://hub.docker.com) account. diff --git a/content/subscription/core-subscription/upgrade.md b/content/subscription/core-subscription/upgrade.md index 8fbb5a8a31..50795cc0e0 100644 --- a/content/subscription/core-subscription/upgrade.md +++ b/content/subscription/core-subscription/upgrade.md @@ -24,12 +24,11 @@ When you upgrade to a paid subscription, you immediately have access to all the 5. Go to your current plan, then select **Change plan** and then choose the plan you'd like to upgrade to. - > **Tip** + > [!TIP] > > If your current plan is a free plan, select **Buy now**. - {.tip} 6. Follow the on-screen instructions. If you have a coupon to use, you can enter it during this step. - \ No newline at end of file + diff --git a/content/subscription/desktop-license.md b/content/subscription/desktop-license.md index c3ec4c20f5..2936c3b636 100644 --- a/content/subscription/desktop-license.md +++ b/content/subscription/desktop-license.md @@ -15,7 +15,7 @@ Our [Docker Subscription Service Agreement](https://www.docker.com/legal/docker- Read the [Blog](https://www.docker.com/blog/updating-product-subscriptions/) and [Docker subscription FAQs](https://www.docker.com/pricing/faq) to learn how this may affect companies using Docker Desktop. -> **Note** +> [!NOTE] > > The licensing and distribution terms for Docker and Moby open-source projects, such as Docker Engine, aren't changing. @@ -24,7 +24,6 @@ Docker Desktop is built using open-source software. For information about the li Docker Desktop distributes some components that are licensed under the GNU General Public License. Select [here](https://download.docker.com/opensource/License.tar.gz) to download the source for these components. -> **Tip** +> [!TIP] > > Explore [Docker subscriptions](https://www.docker.com/pricing/) to see what else Docker can offer you. -{ .tip } \ No newline at end of file diff --git a/content/trusted-content/insights-analytics.md b/content/trusted-content/insights-analytics.md index 509532e0ac..c54651e028 100644 --- a/content/trusted-content/insights-analytics.md +++ b/content/trusted-content/insights-analytics.md @@ -11,12 +11,11 @@ Insights and analytics provides usage analytics for Docker Verified Publisher (DVP) and Docker-Sponsored Open Source (DSOS) images on Docker Hub. This includes self-serve access to image and extension usage metrics for a desired time span. You can also display the number of image pulls by tag or by digest, and get breakdowns by geolocation, cloud provider, client, and more. -> **Tip** +> [!TIP] > > Head to the [Docker Verified Publisher Program](https://www.docker.com/partners/programs/) or [Docker-Sponsored Open Source](https://www.docker.com/community/open-source/application/#) pages to learn more about the programs. -{ .tip } ## View the image's analytics data @@ -35,11 +34,10 @@ To view data in the chart: ![Insights and analytics chart visualization](./images/chart.png) -> **Tip** +> [!TIP] > > Hovering your cursor over the chart displays a tooltip, showing precise data > for points in time. -{ .tip } ### Share analytics data @@ -229,11 +227,10 @@ This section contains information about privacy-protecting measures that ensures consumers of content on Docker Hub remain completely anonymous. -> **Important** +> [!IMPORTANT] > > Docker never shares any Personally Identifiable Information (PII) as part of > analytics data. -{ .important } The image pulls summary dataset includes unique IP address count. This data point only includes the number of distinct unique IP addresses that request an image. diff --git a/content/trusted-content/official-images/_index.md b/content/trusted-content/official-images/_index.md index 7f81fee05a..96cb5a7e7f 100644 --- a/content/trusted-content/official-images/_index.md +++ b/content/trusted-content/official-images/_index.md @@ -11,7 +11,7 @@ aliases: The [Docker Official Images](https://hub.docker.com/search?q=&type=image&image_filter=official) are a curated set of Docker repositories hosted on Docker Hub. -> **Note** +> [!NOTE] > > Use of Docker Official Images is subject to [Docker's Terms of Service](https://www.docker.com/legal/docker-terms-service/). diff --git a/hugo_stats.json b/hugo_stats.json index bb6b3b8896..187416e7d7 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -166,13 +166,16 @@ "border-b-4", "border-b-gray-light-400", "border-b-green-light-400", + "border-blue-light", "border-blue-light-500", "border-divider-light", "border-gray-light-100", "border-gray-light-200", + "border-green-light", "border-l-2", "border-l-4", "border-l-magenta-light", + "border-violet-light", "bottom-0", "box-content", "build-push-action", @@ -203,10 +206,13 @@ "dark:border-b-blue-dark-600", "dark:border-b-gray-dark-400", "dark:border-b-green-dark-400", + "dark:border-blue-dark", "dark:border-divider-dark", "dark:border-gray-dark-200", "dark:border-gray-dark-400", + "dark:border-green-dark", "dark:border-l-magenta-dark", + "dark:border-violet-dark", "dark:decoration-blue-dark", "dark:fill-blue-dark", "dark:focus:outline-blue-dark", @@ -229,6 +235,7 @@ "dark:text-gray-dark-600", "dark:text-gray-dark-700", "dark:text-gray-dark-800", + "dark:text-green-dark", "dark:text-magenta-dark", "dark:text-violet-dark", "dark:text-white", @@ -452,6 +459,7 @@ "text-gray-light-500", "text-gray-light-600", "text-gray-light-800", + "text-green-light", "text-left", "text-lg", "text-magenta-light", @@ -460,7 +468,6 @@ "text-white", "text-xl", "text-xs", - "tip", "to-75%", "to-blue-light-500", "to-magenta-light-400", @@ -481,7 +488,6 @@ "w-[32px]", "w-full", "w-lvw", - "warning", "xl:grid-cols-3", "xl:grid-cols-4", "xl:grid-cols-main-xl", diff --git a/layouts/shortcodes/admin-domains.html b/layouts/shortcodes/admin-domains.html index 7eae1f14eb..d85f0aaad3 100644 --- a/layouts/shortcodes/admin-domains.html +++ b/layouts/shortcodes/admin-domains.html @@ -16,7 +16,7 @@ 4. Continue with the on-screen instructions to get a verification code for your domain as a **TXT Record Value**. - > **Note** + > [!NOTE] > > Format your domains without protocol or www information, for example, > `yourcompany.example`. This should include all email domains and @@ -24,7 +24,7 @@ > `yourcompany.example` and `us.yourcompany.example`. Public domains such as > `gmail.com`, `outlook.com`, etc. aren’t permitted. - > **Tip** + > [!TIP] > > Make sure that the TXT record name that you create on your DNS matches > the domain you registered on Docker in Step 4. For example, @@ -32,7 +32,6 @@ > you need to create a TXT record within the same name/zone `us`. > A root domain such as `yourcompany.example` needs a TXT record on the > root zone, which is typically denoted with the `@` name for the record. - { .tip } 5. Once you have waited 72 hours for the TXT record verification, you can then select **Verify** next to the domain you've added, diff --git a/layouts/shortcodes/admin-registry-access.html b/layouts/shortcodes/admin-registry-access.html index 6b6649457e..83b39a75a6 100644 --- a/layouts/shortcodes/admin-registry-access.html +++ b/layouts/shortcodes/admin-registry-access.html @@ -11,18 +11,17 @@ To configure Registry Access Management permissions, perform the following steps 2. {{ $ram_navigation }} 3. Enable Registry Access Management to set the permissions for your registry. - > **Note** + > [!NOTE] > > When enabled, the Docker Hub registry is set by default, however you can also restrict this registry for your developers. 4. Select **Add registry** and enter your registry details in the applicable fields, and then select **Create** to add the registry to your list. 5. Verify that the registry appears in your list and select **Save changes**. - > **Note** + > [!NOTE] > > Once you add a registry, it can take up to 24 hours for the changes to be enforced on your developers’ machines. If you want to apply the changes sooner, you must force a Docker logout on your developers’ machine and have the developers re-authenticate for Docker Desktop. Also, there is no limit on the number of registries you can add. See the Caveats section below to learn more about limitations when using this feature. - > **Tip** + > [!TIP] > > Since RAM sets policies about where content can be fetched from, the [ADD](/reference/dockerfile/#add) instruction of the Dockerfile, when the parameter of the ADD instruction is a URL, is also subject to registry restrictions. It's recommended that you add the domains of URL parameters to the list of allowed registry addresses under the Registry Access Management settings of your organization. - { .tip } diff --git a/layouts/shortcodes/admin-sso-config.md b/layouts/shortcodes/admin-sso-config.md index af389194fa..a5377037b7 100644 --- a/layouts/shortcodes/admin-sso-config.md +++ b/layouts/shortcodes/admin-sso-config.md @@ -8,7 +8,7 @@ {{ $sso_navigation = "Select your organization or company in the left navigation drop-down menu, and then select **SSO and SCIM.**" }} {{ end }} -> **Important** +> [!IMPORTANT] > > If your IdP setup requires an Entity ID and the ACS URL, you must select the > **SAML** tab in the **Authentication Method** section. For example, if your @@ -16,7 +16,6 @@ > AD, you must select **SAML**. If you are [configuring Open ID Connect with Entra ID (formerly Azure AD)](https://docs.microsoft.com/en-us/powerapps/maker/portals/configure/configure-openid-settings) select > **Azure AD (OIDC)** as the authentication method. Also, IdP initiated connections > aren't supported at this time. -{ .important} After your domain is verified, create an SSO connection. @@ -24,7 +23,7 @@ After your domain is verified, create an SSO connection. 2. {{ $sso_navigation }} 3. In the SSO connections table select **Create Connection**, and create a name for the connection. - > **Note** + > [!NOTE] > > You have to verify at least one domain before creating the connections. diff --git a/layouts/shortcodes/admin-sso-connect.md b/layouts/shortcodes/admin-sso-connect.md index 6821bb26b1..0f8d84df41 100644 --- a/layouts/shortcodes/admin-sso-connect.md +++ b/layouts/shortcodes/admin-sso-connect.md @@ -19,7 +19,7 @@ After you’ve completed the SSO configuration process in Docker, you can test t 1. Authenticate through email instead of using your Docker ID, and test the login process. 2. To authenticate through CLI, your users must have a PAT before you enforce SSO for CLI users. ->**Important** +> [!IMPORTANT] > > SSO has Just-in-Time (JIT) provisioning enabled by default, unless you have [disabled it](/security/for-admins/provisioning/just-in-time/#sso-authentication-with-jit-provisioning-disabled). This means your users are auto-provisioned to your organization. > @@ -29,7 +29,6 @@ After you’ve completed the SSO configuration process in Docker, you can test t > - [Entra ID (formerly Azure AD)](https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-restrict-your-app-to-a-set-of-users) > > Alternatively, see [Manage how users are provisioned](/security/for-admins/single-sign-on/manage/#manage-how-users-are-provisioned). -{ .important} The SSO connection is now created. You can continue to set up SCIM without enforcing SSO log-in. For more information about setting up SCIM, see [Set up SCIM](/security/for-admins/provisioning/scim/). @@ -46,7 +45,6 @@ The SSO connection is now created. You can continue to set up SCIM without enfor Your users must now sign in to Docker with SSO. -> **Important** +> [!IMPORTANT] > > If SSO isn't enforced, users can choose to sign in with either their Docker ID or SSO. -{ .important} diff --git a/layouts/shortcodes/admin-sso-management-users.md b/layouts/shortcodes/admin-sso-management-users.md index 6f7835a7d8..c89cde8192 100644 --- a/layouts/shortcodes/admin-sso-management-users.md +++ b/layouts/shortcodes/admin-sso-management-users.md @@ -22,7 +22,7 @@ 4. Select **Disable** to confirm.` }} {{ end }} -> **Important** +> [!IMPORTANT] > > SSO has Just-In-Time (JIT) Provisioning enabled by default unless you have [disabled it](/security/for-admins/provisioning/just-in-time/#sso-authentication-with-jit-provisioning-disabled). This means your users are auto-provisioned to your organization. > @@ -32,7 +32,6 @@ > - [Entra ID (formerly Azure AD)](https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-restrict-your-app-to-a-set-of-users) > > Alternatively, see [Manage how users are provisioned](#manage-how-users-are-provisioned). -{ .important} ### Add guest users when SSO is enabled From de909cde37007cdb06063cc41de3ec603458adc6 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 17:08:45 +0200 Subject: [PATCH 08/11] chore: use experimental shortcode Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/build/bake/_index.md | 11 ++++++----- content/build/ci/github-actions/build-summary.md | 7 +++---- content/build/ci/github-actions/cache.md | 10 +++++----- content/desktop/dev-environments/_index.md | 7 +++---- content/desktop/use-desktop/builds.md | 7 +++---- content/desktop/use-desktop/volumes.md | 7 +++---- content/desktop/wasm.md | 11 +++++------ content/engine/install/rhel.md | 7 +++---- content/extensions/private-marketplace.md | 8 +++----- content/includes/dockerfile-labs-channel.md | 9 ++++----- .../integrations/source-code-management/github.md | 7 +++---- content/scout/policy/remediation.md | 7 +++---- 12 files changed, 44 insertions(+), 54 deletions(-) diff --git a/content/build/bake/_index.md b/content/build/bake/_index.md index fae941e7a9..17ec6eb4a8 100644 --- a/content/build/bake/_index.md +++ b/content/build/bake/_index.md @@ -5,11 +5,12 @@ aliases: - /build/customize/bake/ --- -> **Experimental** -> -> Bake is an experimental feature, and we are looking for -> [feedback from users](https://github.com/docker/buildx/issues). -{ .experimental } +{{% experimental %}} + +Bake is an experimental feature, and we are looking for +[feedback from users](https://github.com/docker/buildx/issues). + +{{% /experimental %}} Bake is a feature of Docker Buildx that lets you define your build configuraton using a declarative file, as opposed to specifying a complex CLI expression. It diff --git a/content/build/ci/github-actions/build-summary.md b/content/build/ci/github-actions/build-summary.md index dd5eba530d..0a598a7a28 100644 --- a/content/build/ci/github-actions/build-summary.md +++ b/content/build/ci/github-actions/build-summary.md @@ -32,10 +32,9 @@ message that caused the build to fail: {{< introduced desktop 4.31 >}} -> **Beta feature** -> -> Import builds is currently in [Beta](../../../release-lifecycle.md#Beta). -{ .experimental } +{{% experimental title="Beta feature" %}} +Import builds is currently in [Beta](../../../release-lifecycle.md#Beta). +{{% /experimental %}} The job summary includes a link for downloading a build record archive for the run. The build record archive is a ZIP file containing the details about a build diff --git a/content/build/ci/github-actions/cache.md b/content/build/ci/github-actions/cache.md index 3479a8c854..10be7423c6 100644 --- a/content/build/ci/github-actions/cache.md +++ b/content/build/ci/github-actions/cache.md @@ -83,11 +83,11 @@ jobs: ### Cache backend API -> Experimental -> -> This cache exporter is experimental. Please provide feedback on [BuildKit repository](https://github.com/moby/buildkit) -> if you experience any issues. -{ .experimental } +{{% experimental %}} +This cache exporter is experimental. Please provide feedback on the +[BuildKit repository](https://github.com/moby/buildkit) +if you experience any issues. +{{% /experimental %}} The [GitHub Actions cache exporter](../../cache/backends/gha.md) backend uses the [GitHub Cache API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md) diff --git a/content/desktop/dev-environments/_index.md b/content/desktop/dev-environments/_index.md index dbad564680..88e476d1d0 100644 --- a/content/desktop/dev-environments/_index.md +++ b/content/desktop/dev-environments/_index.md @@ -6,10 +6,9 @@ title: Overview of Dev Environments {{< include "dev-envs-changing.md" >}} -> **Beta** -> -> The Dev Environments feature is currently in [Beta](../../release-lifecycle.md#beta). -{ .experimental } +{{% experimental title="Beta" %}} +The Dev Environments feature is currently in [Beta](../../release-lifecycle.md#beta). +{{% /experimental %}} Dev Environments let you create a configurable developer environment with all the code and tools you need to quickly get up and running. diff --git a/content/desktop/use-desktop/builds.md b/content/desktop/use-desktop/builds.md index de1ce19d46..ae23f0a3df 100644 --- a/content/desktop/use-desktop/builds.md +++ b/content/desktop/use-desktop/builds.md @@ -40,10 +40,9 @@ Docker Desktop settings. ### Import builds -> **Beta feature** -> -> Import builds is currently in [Beta](../../release-lifecycle.md#Beta). -{ .experimental } +{{% experimental title="Beta feature" %}} +Import builds is currently in [Beta](../../release-lifecycle.md#Beta). +{{% /experimental %}} The **Import builds** button lets you import build records for builds by other people, or builds in a CI environment. When you've imported a build record, it diff --git a/content/desktop/use-desktop/volumes.md b/content/desktop/use-desktop/volumes.md index e9bf4ced7e..b053e4690b 100644 --- a/content/desktop/use-desktop/volumes.md +++ b/content/desktop/use-desktop/volumes.md @@ -117,10 +117,9 @@ To empty a volume: ## Export a volume -> **Beta feature** -> -> The export volume feature is currently in [Beta](../../release-lifecycle.md/#beta). -{ .experimental } +{{% experimental title="Beta feature" %}} +The export volume feature is currently in [Beta](../../release-lifecycle.md/#beta). +{{% /experimental %}} You can export the content of a volume to a local file, a local image, an to an image in Docker Hub, or to a supported cloud provider. When exporting content diff --git a/content/desktop/wasm.md b/content/desktop/wasm.md index cf03a56783..2b818df904 100644 --- a/content/desktop/wasm.md +++ b/content/desktop/wasm.md @@ -5,12 +5,11 @@ keywords: Docker, WebAssembly, wasm, containerd, engine toc_max: 3 --- -> **Beta** -> -> The Wasm feature is currently in [Beta](../release-lifecycle.md/#beta). -> We recommend that you do not use this feature in production environments as -> this feature may change or be removed from future releases. -{ .experimental } +{{% experimental title="Beta" %}} +The Wasm feature is currently in [Beta](../release-lifecycle.md/#beta). +We recommend that you do not use this feature in production environments as +this feature may change or be removed from future releases. +{{% /experimental %}} Wasm (short for WebAssembly) is a fast, light alternative to the Linux and Windows containers you’re using in Docker today (with diff --git a/content/engine/install/rhel.md b/content/engine/install/rhel.md index cad8626161..5e279968a6 100644 --- a/content/engine/install/rhel.md +++ b/content/engine/install/rhel.md @@ -16,10 +16,9 @@ aliases: download-url-base: https://download.docker.com/linux/rhel --- -> **Experimental** -> -> Support for Docker Engine on RHEL x86_64 and aarch64 is experimental. -{ .experimental } +{{% experimental %}} +Support for Docker Engine on RHEL x86_64 and aarch64 is experimental. +{{% /experimental %}} > **Docker Desktop for Linux** is also available for RHEL. > diff --git a/content/extensions/private-marketplace.md b/content/extensions/private-marketplace.md index e7a30a6bae..13862bf866 100644 --- a/content/extensions/private-marketplace.md +++ b/content/extensions/private-marketplace.md @@ -6,11 +6,9 @@ aliases: - /desktop/extensions/private-marketplace/ --- -> **Beta** -> -> This feature is currently in [Beta](../../release-lifecycle.md#beta). It is available to Docker Business customers only. -{ .experimental } - +{{% experimental title="Beta" %}} +This feature is currently in [Beta](../../release-lifecycle.md#beta). It is available to Docker Business customers only. +{{% /experimental %}} Learn how to configure and set up a private marketplace with a curated list of extensions for your Docker Desktop users. diff --git a/content/includes/dockerfile-labs-channel.md b/content/includes/dockerfile-labs-channel.md index 1024fbc8db..ef4232bf62 100644 --- a/content/includes/dockerfile-labs-channel.md +++ b/content/includes/dockerfile-labs-channel.md @@ -1,5 +1,4 @@ -> Experimental -> -> The "labs" channel provides early access to Dockerfile features that are not -> yet available in the stable channel. -{ .experimental } +{{% experimental %}} +The "labs" channel provides early access to Dockerfile features that are not +yet available in the stable channel. +{{% /experimental %}} diff --git a/content/scout/integrations/source-code-management/github.md b/content/scout/integrations/source-code-management/github.md index 730fcedf1f..98be011306 100644 --- a/content/scout/integrations/source-code-management/github.md +++ b/content/scout/integrations/source-code-management/github.md @@ -4,10 +4,9 @@ description: Integrate Docker Scout using the GitHub app to get remediation advi keywords: scout, github, integration, image analysis, supply chain, remediation, source code --- -> **Beta feature** -> -> The GitHub integration is currently in [Beta](../../../release-lifecycle.md#Beta). -{ .experimental } +{{% experimental title="Beta feature" %}} +The GitHub integration is currently in [Beta](../../../release-lifecycle.md#Beta). +{{% /experimental %}} The GitHub app integration for Docker Scout grants Docker Scout access to your source code repository on GitHub. This improved visibility into how your image diff --git a/content/scout/policy/remediation.md b/content/scout/policy/remediation.md index 6aa2de87b4..2df230412c 100644 --- a/content/scout/policy/remediation.md +++ b/content/scout/policy/remediation.md @@ -4,10 +4,9 @@ description: Learn how Docker Scout can help you improve your software quality a keywords: scout, supply chain, security, remediation, automation --- -> **Beta feature** -> -> Remediation with Docker Scout is currently in [Beta](../../release-lifecycle.md#Beta). -{ .experimental } +{{% experimental title="Beta feature" %}} +Remediation with Docker Scout is currently in [Beta](../../release-lifecycle.md#Beta). +{{% /experimental %}} Docker Scout helps you remediate supply chain or security issues by providing recommendations based on policy evaluation results. Recommendations are From 556aa694377dfb8c734da8de3239c1751f1c4319 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 17:09:14 +0200 Subject: [PATCH 09/11] chore: use restricted shortcode Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/build/cache/backends/azblob.md | 9 ++++----- content/build/cache/backends/gha.md | 9 ++++----- content/build/cache/backends/s3.md | 9 ++++----- content/copilot/index.md | 11 ++++++----- content/desktop/install/msi/_index.md | 9 ++++----- content/desktop/install/rhel.md | 7 +++---- content/engine/install/rhel.md | 7 +++---- content/includes/admin-early-access.md | 11 +++++------ .../includes/compose-bridge-early-access.md | 13 ++++++------- content/scout/policy/_index.md | 9 ++++----- content/scout/policy/scores.md | 11 +++++------ content/scout/policy/view.md | 9 ++++----- .../for-admins/enforce-sign-in/methods.md | 18 ++++++++---------- 13 files changed, 60 insertions(+), 72 deletions(-) diff --git a/content/build/cache/backends/azblob.md b/content/build/cache/backends/azblob.md index 609a0457ef..351422d6b6 100644 --- a/content/build/cache/backends/azblob.md +++ b/content/build/cache/backends/azblob.md @@ -6,11 +6,10 @@ aliases: - /build/building/cache/backends/azblob/ --- -> **Experimental** -> -> This is an experimental feature. The interface and behavior are unstable and -> may change in future releases. -{ .restricted } +{{% experimental %}} +This is an experimental feature. The interface and behavior are unstable and +may change in future releases. +{{% /experimental %}} The `azblob` cache store uploads your resulting build cache to [Azure's blob storage service](https://azure.microsoft.com/en-us/services/storage/blobs/). diff --git a/content/build/cache/backends/gha.md b/content/build/cache/backends/gha.md index 9a390ab71e..796398c0ad 100644 --- a/content/build/cache/backends/gha.md +++ b/content/build/cache/backends/gha.md @@ -6,11 +6,10 @@ aliases: - /build/building/cache/backends/gha/ --- -> **Experimental** -> -> This is an experimental feature. The interface and behavior are unstable and -> may change in future releases. -{ .restricted } +{{% restricted %}} +This is an experimental feature. The interface and behavior are unstable and +may change in future releases. +{{% /restricted %}} The GitHub Actions cache utilizes the [GitHub-provided Action's cache](https://github.com/actions/cache) or other diff --git a/content/build/cache/backends/s3.md b/content/build/cache/backends/s3.md index 57aaebc625..8d0024ca7c 100644 --- a/content/build/cache/backends/s3.md +++ b/content/build/cache/backends/s3.md @@ -6,11 +6,10 @@ aliases: - /build/building/cache/backends/s3/ --- -> **Experimental** -> -> This is an experimental feature. The interface and behavior are unstable and -> may change in future releases. -{ .restricted } +{{% restricted %}} +This is an experimental feature. The interface and behavior are unstable and +may change in future releases. +{{% /restricted %}} The `s3` cache storage uploads your resulting build cache to [Amazon S3 file storage service](https://aws.amazon.com/s3/) diff --git a/content/copilot/index.md b/content/copilot/index.md index 0bb65dac2a..36737db6c5 100644 --- a/content/copilot/index.md +++ b/content/copilot/index.md @@ -4,11 +4,12 @@ description: Learn how to use the Docker Extension for GitHub Copilot to streaml keywords: Docker, GitHub Copilot, extension, Visual Studio Code, chat, ai, containerization --- -> **Early Access** -> -> The Docker for GitHub Copilot extension is a part of the [Limited Public Beta](https://github.blog/changelog/2024-05-21-copilot-extensions-now-in-limited-public-beta/) -> for GitHub Copilot Extensions. Only members of the beta program are eligible to use this extension. -{ .restricted } +{{% restricted title="Early access" %}} + +The Docker for GitHub Copilot extension is a part of the [Limited Public Beta](https://github.blog/changelog/2024-05-21-copilot-extensions-now-in-limited-public-beta/) +for GitHub Copilot Extensions. Only members of the beta program are eligible to use this extension. + +{{% /restricted %}} The Docker Extension for GitHub Copilot integrates Docker's capabilities with GitHub Copilot, providing assistance with containerizing applications and diff --git a/content/desktop/install/msi/_index.md b/content/desktop/install/msi/_index.md index bbcf289bdf..0003e96d7f 100644 --- a/content/desktop/install/msi/_index.md +++ b/content/desktop/install/msi/_index.md @@ -4,11 +4,10 @@ description: If you're an IT admin, learn how to deploy Docker Desktop with Micr keywords: msi, docker desktop, windows, installation --- -> **Early Access** -> -> The MSI installer is an [early access](../../../release-lifecycle.md#early-access-ea) feature for Docker Business subscribers. -> It's available to all company owners and organization owners with Docker Desktop version 4.32 and later. -{ .restricted } +{{% restricted title="Early Access" %}} +The MSI installer is an [early access](../../../release-lifecycle.md#early-access-ea) feature for Docker Business subscribers. +It's available to all company owners and organization owners with Docker Desktop version 4.32 and later. +{{% /restricted %}} Docker offers a 64-bit Microsoft Installer (MSI) package designed to assist IT administrators in customizing and deploying Docker Desktop across multiple users or machines in an enterprise environment. diff --git a/content/desktop/install/rhel.md b/content/desktop/install/rhel.md index ba6d4742e9..aa7a5825a2 100644 --- a/content/desktop/install/rhel.md +++ b/content/desktop/install/rhel.md @@ -8,10 +8,9 @@ toc_max: 4 download-url-base: https://download.docker.com/linux/rhel --- -> **Early Access** -> -> Docker Desktop on RHEL is in [Early Access](../../release-lifecycle.md). -{ .restricted } +{{% restricted title="Early Access" %}} +Docker Desktop on RHEL is in [Early Access](../../release-lifecycle.md). +{{% /restricted %}} > **Docker Desktop terms** > diff --git a/content/engine/install/rhel.md b/content/engine/install/rhel.md index 5e279968a6..6ff058f9f8 100644 --- a/content/engine/install/rhel.md +++ b/content/engine/install/rhel.md @@ -20,10 +20,9 @@ download-url-base: https://download.docker.com/linux/rhel Support for Docker Engine on RHEL x86_64 and aarch64 is experimental. {{% /experimental %}} -> **Docker Desktop for Linux** is also available for RHEL. -> -> To get access, join the [Early Access Program](https://www.docker.com/docker-desktop-preview-program/). -{ .restricted } +{{% restricted title="Docker Desktop for Linux is also available for RHEL." %}} +To get access, join the [Early Access Program](https://www.docker.com/docker-desktop-preview-program/). +{{% /restricted %}} To get started with Docker Engine on RHEL, make sure you [meet the prerequisites](#prerequisites), and then follow the diff --git a/content/includes/admin-early-access.md b/content/includes/admin-early-access.md index 7c577839f0..bb14389335 100644 --- a/content/includes/admin-early-access.md +++ b/content/includes/admin-early-access.md @@ -1,6 +1,5 @@ -> **Early Access** -> -> The Docker Admin Console is an [early access](/release-lifecycle#early-access-ea) product. -> -> It's available to all company owners and organization owners. You can still manage companies and organizations in Docker Hub, but the Admin Console includes enhanced features for company-level management. -{ .restricted } +{{% restricted title="Early Access" %}} +The Docker Admin Console is an [early access](/release-lifecycle#early-access-ea) product. + +It's available to all company owners and organization owners. You can still manage companies and organizations in Docker Hub, but the Admin Console includes enhanced features for company-level management. +{{% /restricted %}} diff --git a/content/includes/compose-bridge-early-access.md b/content/includes/compose-bridge-early-access.md index c5faccd334..740d9798eb 100644 --- a/content/includes/compose-bridge-early-access.md +++ b/content/includes/compose-bridge-early-access.md @@ -1,7 +1,6 @@ -> **Early Access** -> -> Compose Bridge is an [Early Access](/release-lifecycle#early-access-ea) product. -> -> If you would like to be considered for Compose Bridge testing, you can -> [sign up for the Early Access program](https://www.docker.com/docker-desktop-preview-program/). -{ .restricted } +{{% restricted title="Early Access" %}} +Compose Bridge is an [Early Access](/release-lifecycle#early-access-ea) product. + +If you would like to be considered for Compose Bridge testing, you can +[sign up for the Early Access program](https://www.docker.com/docker-desktop-preview-program/). +{{% /restricted %}} diff --git a/content/scout/policy/_index.md b/content/scout/policy/_index.md index 3f7cca72eb..cf8c16d1ea 100644 --- a/content/scout/policy/_index.md +++ b/content/scout/policy/_index.md @@ -7,11 +7,10 @@ description: | requirements over time --- -> **Early Access** -> -> Policy Evaluation is an [Early Access](/release-lifecycle/#early-access-ea) -> feature of Docker Scout. -{ .restricted } +{{% restricted title="Early Access" %}} +Policy Evaluation is an [Early Access](/release-lifecycle/#early-access-ea) +feature of Docker Scout. +{{% /restricted %}} In software supply chain management, maintaining the security and reliability of artifacts is a top priority. Policy Evaluation in Docker Scout introduces a diff --git a/content/scout/policy/scores.md b/content/scout/policy/scores.md index 7e5bbcd1c5..b67353c0ad 100644 --- a/content/scout/policy/scores.md +++ b/content/scout/policy/scores.md @@ -6,12 +6,11 @@ description: | keywords: scout, health scores, evaluation, checks, grades, docker hub --- -> **Beta** -> -> Health scores is a [Beta](/release-lifecycle/#beta) feature of Docker Scout. -> The feature is only available to organizations selected to participate in the -> early access program. -{ .restricted } +{{% restricted title="Beta" %}} +Health scores is a [Beta](/release-lifecycle/#beta) feature of Docker Scout. +The feature is only available to organizations selected to participate in the +early access program. +{{% /restricted %}} Docker Scout health scores provide a security assessment, and overall supply chain health, of images on Docker Hub, helping you determine whether an image diff --git a/content/scout/policy/view.md b/content/scout/policy/view.md index 854c6300db..1cac54a112 100644 --- a/content/scout/policy/view.md +++ b/content/scout/policy/view.md @@ -6,11 +6,10 @@ description: | keywords: scout, policy, status, vulnerabilities, supply chain, cves, licenses --- -> **Early Access** -> -> Policy Evaluation is an [Early Access](/release-lifecycle/#early-access-ea) -> feature of Docker Scout. -{ .restricted } +{{% restricted title="Earyl Access" %}} +Policy Evaluation is an [Early Access](/release-lifecycle/#early-access-ea) +feature of Docker Scout. +{{% /restricted %}} You can track policy status for your artifacts from the [Docker Scout Dashboard](#dashboard), or using the [CLI](#cli). diff --git a/content/security/for-admins/enforce-sign-in/methods.md b/content/security/for-admins/enforce-sign-in/methods.md index de1c08a4a8..52382bd3b5 100644 --- a/content/security/for-admins/enforce-sign-in/methods.md +++ b/content/security/for-admins/enforce-sign-in/methods.md @@ -8,11 +8,10 @@ This page outlines the different ways you can enforce sign-in for Docker Desktop ## Registry key method (Windows only) -> **Early Access** -> -> The registry key method is an [early access](../../../release-lifecycle.md#early-access-ea) feature for Docker Business subscribers. -> It's available with Docker Desktop version 4.32 and later. -{ .restricted } +{{% restricted title="Early Access" %}} +The registry key method is an [early access](../../../release-lifecycle.md#early-access-ea) feature for Docker Business subscribers. +It's available with Docker Desktop version 4.32 and later. +{{% /restricted %}} 1. Create the registry key. Your new key should look like the following: @@ -50,11 +49,10 @@ There are many ways to deploy the registry key, for example using an MDM solutio ## plist method (Mac only) -> **Early Access** -> -> The plist method is an [early access](../../../release-lifecycle.md#early-access-ea) feature for Docker Business subscribers. -> It's available with Docker Desktop version 4.32 and later. -{ .restricted } +{{% restricted title="Early Access" %}} +The plist method is an [early access](../../../release-lifecycle.md#early-access-ea) feature for Docker Business subscribers. +It's available with Docker Desktop version 4.32 and later. +{{% /restricted %}} 1. Create the file `/Library/Application Support/com.docker.docker/desktop.plist`. 2. Open `desktop.plist` in a text editor and add the following content, where `myorg` is replaced with your organization’s name all lowercase: From be79aba1b628b14323340575568d8c52f41d595d Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 21:04:01 +0200 Subject: [PATCH 10/11] contrib: update instructions and examples for callouts Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/contribute/components/call-outs.md | 54 ++++++++++++---------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/content/contribute/components/call-outs.md b/content/contribute/components/call-outs.md index 48f272d10a..261cef77d2 100644 --- a/content/contribute/components/call-outs.md +++ b/content/contribute/components/call-outs.md @@ -6,14 +6,18 @@ toc_max: 3 We support these broad categories of callouts: +- Alerts (Note, Tip, Important, Warning, Caution) - Version callouts -- Notes (no HTML attribute required) -- Experimental, which use the `{ .experimental }` class -- Restricted, which use the `{ .restricted }` class +- Experimental, which use the `{{%/* experimental */%}}` shortcode +- Restricted, which use the `{{%/* restricted */%}}` shortcode + +The experimental and restricted shortcodes take a title as an argument. The +title is optional, defaults to "Experimental" or "Restricted" respectively, and +is displayed in the callout. ## Examples -{{< introduced buildx 0.10.4 >}} +{{< introduced buildx 0.16.0 >}} > [!NOTE] > @@ -29,13 +33,11 @@ We support these broad categories of callouts: > > For a smaller base image, use `alpine`. - > [!IMPORTANT] > > Treat access tokens like your password and keep them secret. Store your > tokens securely (for example, in a credential manager). - > [!WARNING] > > Removing Volumes @@ -46,18 +48,19 @@ We support these broad categories of callouts: > > The Docker Dashboard does not remove volumes when you delete the app stack. +> [!CAUTION] +> +> Here be dragons. + For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them. -> **Beta feature** -> -> The Builds view is currently in Beta. This feature may change or be removed from future releases. -{ .experimental } +{{% experimental title="Beta feature" %}} +The Builds view is currently in Beta. This feature may change or be removed from future releases. +{{% /experimental %}} -> **Restricted** -> -> Docker Scout is an [early access](/release-lifecycle/#early-access-ea) -> product. -{ .restricted} +{{% restricted %}} +Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product. +{{% /restricted %}} ## Formatting @@ -95,14 +98,17 @@ For both of the following callouts, consult [the Docker release lifecycle](/rele > > The Docker Dashboard does _not_ remove volumes when you delete the app stack. -> **Beta feature** +> [!CAUTION] > -> The Builds view is currently in Beta. This feature may change or be removed from future releases. -{ .experimental } - -> **Restricted** -> -> Docker Scout is an [early access](/release-lifecycle/#early-access-ea) -> product. -{ .restricted } +> Here be dragons. +``` + +```go +{{%/* experimental title="Beta feature" */%}} +The Builds view is currently in Beta. This feature may change or be removed from future releases. +{{%/* /experimental */%}} + +{{%/* restricted */%}} +Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product. +{{%/* /restricted */%}} ``` From eb8614af4dd74d9ad3b2cadcc24e2fe4871b9622 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 15 Aug 2024 21:41:27 +0200 Subject: [PATCH 11/11] hugo: refactor include shortcode mechanics Instead of inserting the raw file contents, use the page object. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/includes/_index.md | 7 +++++++ content/includes/admin-early-access.md | 3 +++ content/includes/compose-bridge-early-access.md | 3 +++ content/includes/dockerfile-labs-channel.md | 3 +++ content/includes/index.md | 0 hugo_stats.json | 4 ++++ layouts/shortcodes/include.html | 4 +++- 7 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 content/includes/_index.md delete mode 100644 content/includes/index.md diff --git a/content/includes/_index.md b/content/includes/_index.md new file mode 100644 index 0000000000..53ee6a2b05 --- /dev/null +++ b/content/includes/_index.md @@ -0,0 +1,7 @@ +--- +cascade: +- build: + list: local + publishResources: false + render: never +--- diff --git a/content/includes/admin-early-access.md b/content/includes/admin-early-access.md index bb14389335..7fd75ffd5b 100644 --- a/content/includes/admin-early-access.md +++ b/content/includes/admin-early-access.md @@ -1,3 +1,6 @@ +--- +--- + {{% restricted title="Early Access" %}} The Docker Admin Console is an [early access](/release-lifecycle#early-access-ea) product. diff --git a/content/includes/compose-bridge-early-access.md b/content/includes/compose-bridge-early-access.md index 740d9798eb..396ffeb3d3 100644 --- a/content/includes/compose-bridge-early-access.md +++ b/content/includes/compose-bridge-early-access.md @@ -1,3 +1,6 @@ +--- +--- + {{% restricted title="Early Access" %}} Compose Bridge is an [Early Access](/release-lifecycle#early-access-ea) product. diff --git a/content/includes/dockerfile-labs-channel.md b/content/includes/dockerfile-labs-channel.md index ef4232bf62..029b25a635 100644 --- a/content/includes/dockerfile-labs-channel.md +++ b/content/includes/dockerfile-labs-channel.md @@ -1,3 +1,6 @@ +--- +--- + {{% experimental %}} The "labs" channel provides early access to Dockerfile features that are not yet available in the stable channel. diff --git a/content/includes/index.md b/content/includes/index.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/hugo_stats.json b/hugo_stats.json index 187416e7d7..5514e88364 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -175,6 +175,7 @@ "border-l-2", "border-l-4", "border-l-magenta-light", + "border-red-light", "border-violet-light", "bottom-0", "box-content", @@ -212,6 +213,7 @@ "dark:border-gray-dark-400", "dark:border-green-dark", "dark:border-l-magenta-dark", + "dark:border-red-dark", "dark:border-violet-dark", "dark:decoration-blue-dark", "dark:fill-blue-dark", @@ -237,6 +239,7 @@ "dark:text-gray-dark-800", "dark:text-green-dark", "dark:text-magenta-dark", + "dark:text-red-dark", "dark:text-violet-dark", "dark:text-white", "dark:to-blue-dark-100", @@ -463,6 +466,7 @@ "text-left", "text-lg", "text-magenta-light", + "text-red-light", "text-sm", "text-violet-light", "text-white", diff --git a/layouts/shortcodes/include.html b/layouts/shortcodes/include.html index 4d7f13421e..4730fcb0ff 100644 --- a/layouts/shortcodes/include.html +++ b/layouts/shortcodes/include.html @@ -1,2 +1,4 @@ {{ $fileToInclude := .Get 0 }} -{{ os.ReadFile (printf "includes/%s" $fileToInclude) | page.RenderString }} +{{ with (site.GetPage (printf "includes/%s" $fileToInclude)) }} + {{ page.RenderString (dict "display" "block") .RenderShortcodes }} +{{ end }}