Ярлыки расширенных образов

Этикетки указаны в Dockerfile расширения и используются для предоставления информации о расширении.

Этикетка

Необходимый

Описание

Пример

org.opencontainers.image.title

Да

Человекочитаемый заголовок образа (строка). Это отображается в пользовательском интерфейсе для Docker Desktop.

мое расширение

org.opencontainers.image.description

Да

Читаемое человеком описание программного обеспечения, упакованного в образ (строка)

Это расширение крутое.

org.opencontainers.image.vendor

Да

Название распространяющей организации, организации или физического лица.

Акме, Инк.

com.docker.desktop.extension.api.version

Да

Версия диспетчера расширений Docker, с которой совместимо расширение. Он должен следовать за семантическое управление версиями.

Конкретная версия, такая как 0.1.0 или выражение ограничения: >= 0.1.0, >= 1.4.7, < 2.0 . Для вашего первого расширения вы можете использовать docker extension version, чтобы узнать версию API SDK, и указывает >= <SDK_API_VERSION>.

com.docker.desktop.extension.icon

Да

Значок расширения (формат: .svg .png .jpg)

{{ site.docs_url }}/assets/images/engine.svg

com.docker.extension.screenshots

Да

Массив JSON URL-адресов образов и альтернативный текст, отображаемый для пользователей (в том порядке, в котором они появляются в ваших метаданных) на странице сведений о вашем расширении. Примечание. Рекомендуемый размер скриншотов– 2400x1600пикселей.

"[{"alt":"alternative text for image 1", "url":"https://foo.bar/image1.png"}, {"alt":"alternative text for image2", "url":"https://foo.bar/image2.jpg"}]"

com.docker.extension.detailed-description

Да

Дополнительная информация в виде обычного текста или HTML о расширении, которая будет отображаться в диалоговом окне сведений.

My detailed description или <h1>My detailed description</h1>

com.docker.extension.publisher-url

Да

URL-адрес веб-сайта издателя, который будет отображаться в диалоговом окне сведений.

https://foo.bar

com.docker.extension.additional-urls

Нет

Массив JSON заголовков и дополнительных URL-адресов, отображаемых для пользователей (в порядке их появления в ваших метаданных) на странице сведений о вашем расширении. Мы рекомендуем отображать следующие ссылки, если они применимы: ссылки на документацию, поддержку, условия обслуживания и политику конфиденциальности.

[{"title":"Documentation","url":"https://foo.bar/docs"}, {"title":"Support","url":"https://foo.bar/support"}, {"title":"Terms of Service","url":"https://foo.bar/tos"}, {"title":"Privacy policy","url":"https://foo.bar/privacy-policy"}]

com.docker.extension.changelog

Да

Журнал изменений в виде простого текста или HTML, содержащий изменения только для текущей версии.

Extension changelog или <p>Extension changelog<ul> <li>New feature A</li> <li>Bug fix on feature B</li></ul></p>

com.docker.extension.account-info

Нет

Нужно ли пользователю зарегистрироваться или войти на платформу SaaS, чтобы использовать некоторые функции расширения.

required, если это так, в противном случае оставьте его пустым.

com.docker.extension.categories

Нет

Список категорий Marketplace, к которым принадлежит ваше расширение: ci-cd, container-orchestration, cloud-deployment, cloud-development, database, kubernetes, networking, security,testing-tools, H4. 274663490,volumes. Если вы не укажете данный ярлык, пользователи не смогут найти ваше расширение в магазине расширений при фильтрации по категории. Расширения, опубликованные в Marketplace до 22 сентября 2022 года, были автоматически классифицированы Docker.

Указывается как значения, разделенные запятыми, в случае наличия нескольких категорий, например: kubernetes,security, или одно значение, например kubernetes.

Отсутствуют необходимые ярлыки

Если какая-либо из предыдущих обязательных меток отсутствует в Dockerfile, Docker Desktop считает расширение недействительным и не размещает его в Marketplace.

Стили HTML-контента

Стили CSS Docker Desktop будут применены к предоставленному содержимому HTML. Вы можете убедиться, что оно хорошо отображается на торговой площадке, предварительно просмотрев расширение на торговой площадке. Мы рекомендуем вам следовать нашему Рекомендации по стилю.

Предварительный просмотр расширения в Marketplace

Вы можете проверяет, что метки образов отображаются так, как вы ожидаете.

Когда вы создаёте и устанавливаете неопубликованное расширение, вы можете предварительно просмотреть его на вкладке «Установлено» Marketplace. Вы можете увидеть, как метки расширений отображаются в списке и на странице сведений о расширении.

Примечание

Предварительные версии расширений, уже перечисленных в Marketplace. Когда вы устанавливаете локальный образ расширения, уже опубликованного в Marketplace, например, с тегом latest, ваш локальный образ в настоящее время не определяется как «неопубликованный».

Вы можете изменяет тег своего образа, чтобы иметь другое имя образа, которое не указано в качестве опубликованного расширения. Используйте docker tag org/published-extension unpublished-extension, а затем docker extension install unpublished-extension.

List preview
List preview