diff --git a/_data/toc.yaml b/_data/toc.yaml index 8ce374ede19..1cd7d6b8067 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -3370,6 +3370,8 @@ manuals: section: - path: /docker-hub/publish/ title: Overview + - path: /docker-hub/publish/publish/ + title: Submit a product for Docker Hub - path: /docker-hub/publish/customer_faq/ title: User FAQs - path: /docker-hub/publish/publisher_faq/ diff --git a/docker-hub/publish/index.md b/docker-hub/publish/index.md index 6b5511c88d5..fa7d3b8e1d5 100644 --- a/docker-hub/publish/index.md +++ b/docker-hub/publish/index.md @@ -53,9 +53,9 @@ information, see [Bring Your Own License (BYOL) products on Store](byol.md). ### Plugins and agents -ISVs have the ability to create and distribute [plugin images](https://hub.docker.com/search?certification_status=certified&q=&type=plugin) for their customers to integrate with the ISV's proprietary hardware or cloud infrastructure and Docker Enterprise Edition deployments. +ISVs have the ability to create and distribute [plugin images](https://hub.docker.com/search?certification_status=certified&q=&type=plugin) for their customers to integrate with the ISV's proprietary hardware or cloud infrastructure and Docker Enterprise deployments. -You can [apply to be a publisher](https://goto.docker.com/partners) and learn more about our [Technology Partner Program](https://www.docker.com/partners/partner-program#/technology_partner). +You can [apply to be a publisher](https://goto.docker.com/2019-Partner-Program-Technology.html) and learn more about our [Technology Partner Program](https://www.docker.com/partners/partner-program#/technology_partner). ## What's next? diff --git a/docker-hub/publish/publish.md b/docker-hub/publish/publish.md index eb1003fa24f..bcdd07f60df 100644 --- a/docker-hub/publish/publish.md +++ b/docker-hub/publish/publish.md @@ -8,32 +8,28 @@ redirect_from: ## Permitted content and support options -* Content that runs on a Docker Enterprise Edition (Docker Certified - Infrastructure) may be published in the Store. This content may also qualify - to become a Docker Certified Container or Plugin image and be backed by - collaborative Docker/Publisher support +* Content that runs on Docker Enterprise may be published on Docker Hub under a Verified Publisher profile. This content may also qualify + to become a Docker Certified Container or Plugin image, and thus backed by + collaborative Docker/Publisher support. -* Content that runs on the Docker Community Edition may be published in the - Store, but is not supported by Docker nor is it eligible for certification. +* Content that runs on the Docker Community may be published in Docker Hub, but is not supported by Docker nor is it eligible to become Certified. * Content that requires a non Certified Infrastructure environment may not be - published in the Store. + published. -| If your content: | Can publish on Store | Can be certified and supported by Docker | Supported by publisher | +| If your content: | Can publish | Can be Certified | Supported by publisher | |:-----|:--------|:------|:-----| -| Works on Docker Enterprise Edition | YES | YES | Required | -| Works on Docker Community Edition | YES | NO | Optional | +| Works on Docker Enterprise | YES | YES | Required | +| Works on Docker Community | YES | NO | Optional | | Does not work on Docker Certified Infrastructure | NO | N/A | N/A | ## Onboarding The Docker Hub publishing process begins from the landing page: sign in with -your Docker ID and specify a product name and image source from a private -repository. Your product images must be stored in private repositories of Docker -Cloud and/or Hub as they serve as an internal staging area from which you can -revise and submit content for review. +your Docker ID and specify a product name and image source from a private or public +repository. After specifying a source, provide the content-manifest items to populate your product details page. These items include logos, descriptions, and licensing and @@ -127,7 +123,7 @@ of your product, keep your images up-to-date: `apt-get install ...` pull the latest versions of dependencies, which may include security fixes. -## Create and maintain your publisher profile in the Store +## Create and maintain your Verified Publisher profile Let the Docker community know who you are. Add your details, your company story, and what you do. At the very minimum, we require: @@ -136,12 +132,12 @@ story, and what you do. At the very minimum, we require: * Company website * Phone number * Valid company email -* Company icon/logo (square; at least 512x512px +* Company icon/logo (square; at least 512x512px) ## Prepare your image-manifest materials -You must provide the namespace (including repository and tags) of a private +You must provide the namespace (including repository and tags) of a private or public repository on Docker Hub that contains the source for your product. This repository path is not shown to users, but the repositories you choose determine the Product Tiers available for customers to download. @@ -160,18 +156,17 @@ discoverable: 9. Product tier description 10. Product tier price 11. Installation instructions -12. Link to license agreements +12. Link to, or text of, license agreements ### How the manifest information is displayed in the UI -This is an approximate representation. We frequently make enhancements to the -look and some elements might shift around. +This is an approximate representation, and some elements might shift around as we make enhancements. ![manifest information displayed on store UI](images/subscribed.png) ## Support your users -Docker users who download your content from the Store might need your help +Docker users who download your content might need help later, so be prepared for questions! The information you provide with your submission saves support time in the future. @@ -183,14 +178,13 @@ there self-help or troubleshooting resources available? ### Support SLA -Include a Service Level Agreement (SLA) for each image you're offering for the -Store. An SLA is your commitment to your users about the nature and level of +Include a Service Level Agreement (SLA) for each image you're offering. An SLA is your commitment to your users about the nature and level of support you provide to them. Make sure your SLA includes support hours and response-time expectations, where applicable. ## Security and audit policies -Docker Hub [scans](#docker-security-scanning) your official images for +Docker Hub [scans](#docker-security-scanning) your content for vulnerabilities with the Docker Security Scanning tool, and [audits](#usage-audit-and-reporting) consumer activity of your images to provide you intelligence about the use of your product. @@ -285,15 +279,6 @@ To interpret the results of a scanned image: National Vulnerability Database (NVD) provides CVSS scores for almost all known vulnerabilities. -* Docker classifies the severity of issues per CVSS range, Docker classification, - and service level agreement (SLA) as follows. - -| CVSS range | Docker classification | SLA for fixing issues | -|:-----|:--------|:------| -| 7.0 to 10.0 | Critical | Within 72 hours of notification | -| 4.0 to 6.9 | Major | Within 7 days of notification | -| 0.1 to 3.9 | Minor | No SLA. Best-effort to fix or address in documentation. | - * In addition to CVSS, the Docker Security team can identify or classify vulnerabilities that need to be fixed, and categorize them in the minor-to-critical range. @@ -304,14 +289,6 @@ To interpret the results of a scanned image: * If you use Docker’s Scanning Service, you can subscribe to a notification service for new vulnerabilities. -* Failure to meet above SLAs may cause the listing to be put on “hold”. - -* A warning label shows up on the marketplace listing. An email is sent to the - users who have downloaded and subscribed for notifications. - -* A Repo’s listing can stay in the "hold" state for a maximum of 1 month, after - which the listing is revoked. - ### Usage audit and reporting Unless otherwise negotiated, an audit of activity on publisher content is @@ -330,7 +307,7 @@ There are three types of certification that appear in Docker Hub. ![certified container badge](images/certified_container.png) Certifies that a container image on Docker Hub has been tested; complies best -practices guidelines; runs on a Docker Certified Infrastructure; has proven +practices guidelines; runs on Docker Certified Infrastructure; has proven provenance; been scanned for vulnerabilities; and is supported by Docker and the content publisher @@ -341,12 +318,6 @@ access system level Docker APIs. Docker Certified Plugins provide the same level of assurance as a Docker Certified Container, but go further by having passed an additional suite of API compliance testing. -![certified plugins badge](images/certified_infrastructure.png) - -Indicates that the release of the Docker Edition and the underlying platform -have been tested together and are supported in combination by both Docker and -the partner. - ### Docker Certified Publisher FAQ #### What is the Docker Certified program? @@ -354,16 +325,12 @@ the partner. Docker Certified Container images and plugins are meant to differentiate high quality content on Docker Hub. Customers can consume Certified Containers with confidence knowing that both Docker and the publisher stands behind the -solution. Further details can be found in the -[Docker Partner Program Guide](https://www.docker.com/partnerprogramguide){: target="_blank" class="_"}. +solution. Further details and an application can be [found here.](https://goto.docker.com/2019-Partner-Program-Technology.html){: target="_blank" class="_"}. #### What are the benefits of Docker Certified? Docker Hub promotes Docker Certified Containers and Plugins running on Docker -Certified Infrastructure trusted and high quality content. With over 8B image -pulls and access to Docker’s large customer base, a publisher can differentiate -their content by certifying their images and plugins. With a revenue share -agreement, Docker can be a channel for your content. The Docker Certified badge +Certified Infrastructure trusted and high quality content. The Docker Certified badge can also be listed alongside external references to your product. #### How is the Docker Certified Container image listed on Docker Hub? @@ -376,7 +343,7 @@ search parameters to show only certified content. #### Is certification optional or required? -Certification is recommended for most commercial and supported container images. +Certification is recommended for all commercial and supported container images. Free, community, and other commercial (non-certified) content may also be listed on Docker Hub. @@ -384,10 +351,9 @@ on Docker Hub. #### How is support handled? -All Docker Certified Container images and plugins running on Docker Certified -Infrastructure come with SLA based support provided by the publisher and Docker. +All Docker Certified Container images and plugins running on Docker Enterprise come with support provided directly by the publisher, under your existing SLA. Normally, a customer contacts the publisher for container and application level -issues. Likewise, a customer contacts Docker for Docker Edition support. In the +issues. Likewise, a customer contacts Docker for Docker Enterprise support. In the case where a customer calls Docker (or vice versa) about an issue on the application, Docker advises the customer about the publisher support process and performs a handover directly to the publisher if required. TSAnet is required @@ -396,42 +362,15 @@ for exchange of support tickets between the publisher and Docker. #### How does a publisher apply to the Docker Certified program? Start by applying to be a [Docker Technology -Partner](https://goto.docker.com/partners){: target="_blank" class="_"} - -* Requires acceptance of partnership agreement for completion - -* Identify commercial content that can be listed on Store and includes a support - offering - -* Test your image against the Docker CS Engine 1.12+ or on a Docker Certified - Infrastructure version 17.03 and above (Plugins must run on 17.03 and above) - -* Submit your image for Certification through the publisher portal. Docker - scans the image and works with you to address vulnerabilities. Docker also - conducts a best practices review of the image. - -* Be a [TSAnet](https://www.tsanet.org/){: target="_blank" class="_"} member or - join the Docker Limited Group. - -* Upon completion of Certification criteria, and acceptance by - Docker, the Publisher’s product page is updated to reflect Certified status. - -#### Is there a fee to join the program? - -In the future, Docker may charge a small annual listing fee. This is waived for -the initial period. +Partner](https://goto.docker.com/2019-Partner-Program-Technology.html){: target="_blank" class="_"} #### What is the difference between Official Images and Docker Certified? -Many Official images transition to the Docker Certified program and are -maintained and updated by the original owner of the software. Docker -continues to maintain some of the base OS images and language frameworks. +Official Images is a program sponsored by Docker for the curation and packaging of Open Source Software. While upstream vendors are sometimes involved, this is not always the case. Docker Certified content is explicitly provided, maintained, and supported directly by the ISV. #### How is certification of plugins handled? Docker Certification program recognizes the need to apply special scrutiny and testing to containers that access system level interfaces like storage volumes and networking. Docker identifies these special containers as “Plugins” which -require additional testing by the publisher or Docker. These plugins employ the -V2 Plugin Architecture that was first made available in 1.12 (experimental) and -now available in Docker Enterprise Edition 17.03 +require additional testing by the publisher or Docker. diff --git a/docker-hub/publish/publisher_faq.md b/docker-hub/publish/publisher_faq.md index 5500002e519..8ebc639fdce 100644 --- a/docker-hub/publish/publisher_faq.md +++ b/docker-hub/publish/publisher_faq.md @@ -9,38 +9,21 @@ redirect_from: ## Certification program -### What is the certification program for images and plugins, and what are some benefits? +### What is the certification program for containers and plugins, and what are some benefits? -The Docker Certification program for Infrastructure, Images, and Plugins is +The Docker Certification program for Containers and Plugins is designed for both technology partners and enterprise customers to recognize high-quality Containers and Plugins, provide collaborative support, and ensure -compatibility with Docker EE. Docker Certification is aligned to the available -Docker EE infrastructure and gives enterprises a trusted way to run more +compatibility with the Docker Enterprise platform. Docker Certified products give enterprises a trusted way to run more technology in containers with support from both Docker and the publisher. The -[Docker Technology Partner guide](https://www.docker.com/partners/partner-program#/technology_partner) -explains the Technology Partner program and the Docker Certification Program for -Infrastructure, Images, and Plugins in more detail. +[Docker Technology Partner guide](https://www.docker.com/sites/default/files/d8/2018-12/Docker-Technology-Partner-Program-Guide-120418.pdf) +explains the Technology Partner program, inclusive of process and requirements to Certify Containers and Plugins. ## Publisher signup and approval ### How do I get started with the publisher signup and approval process? -Start by applying to be a Docker Technology Partner at https://goto.docker.com/partner and click on "Publisher". - -* Requires acceptance of partnership agreement for completion -* Identify content that can be listed on Hub and includes a support offering -* Test your image against Docker Certified Infrastructure version 17.03 and -above (Plugins must run on 17.03 and above). -* Submit your image for Certification through the publisher portal. Docker -scans the image and work with you to address vulnerabilities. Docker also -conducts a best practices review of the image. -* Be a TSAnet member or join the Docker Limited Group. -* Upon completion of Certification criteria, and acceptance by Docker, -Publisher’s product page is updated to reflect Certified status. - -### What is the Docker Hub Publisher Program application timeline? - -1-2 weeks. +Start by completing our [Technology Partner application](https://goto.docker.com/2019-Partner-Program-Technology.html). Docker's partner team will review your application, and follow up directly with further steps. If you have any questions or concerns, please reach out directly to us at partners@docker.com! ### Can we have a group of people work on the same product and publish to Docker Hub? (This replicates our internal workflow where more than one person is working on Dockerizing our product.) @@ -52,14 +35,15 @@ Yes. You can submit your content as a team. The customer will be given the permissions to docker pull any tag associated with the source repo specified. We recommend that you create a distinct repo per plan and only use tags for different versions of that specific plan. For example, if you have a community, pro, and enterprise plan of a single product, you should create three separate repos, `namespace/community, namespace/pro, and namespace/enterprise`. Once a customer is entitled to your enterprise plan, they will be able to pull `store/namespace/enterprise:anytag`. -### How long does it typically take to have an image approved? - -2 Weeks. +### What is the typical publishing time for new products and updates? +Products are typically published within 24hrs of submission. ### Once a product is published, what is the process for pushing a new build (1.2, 1.3)? Will we simply edit the same product, adding the newly tagged repos? Edit the same product and update with the newly tagged repos. +Additionally, for product updates, you may include a set of *Release Notes*. These notes will not be published with the product listing itself. Instead, they will be emailed directly to the current subscriber of the product. This ensures that consumers will have timely, valuable alerts about the availability of new images and significant changes. + ### On the Information page, organization details are required. Do we need to fill those in again for every product we publish, or are they carried over? And if we change them for a later image publish, are they updated for all images published by our organization? Organization details need to be filled in only once. Updating organization info @@ -71,7 +55,7 @@ We don't support the abiltiy to view available tags for published products becau Official images and community images have available tags visible because anyone can access any tag at any time anonymously. -We aim to have product listings published with the concept of versions, allowing publishers to manage which versions of their products they expose to customers for access. +In the future, we may enable product listings published with the concept of versions, allowing publishers to manage which versions of their products they expose to customers for access. ### On the page for another vendor’s product on Docker Hub, I see the following chunks of data: How do these fields map to the following that are required in the publish process? @@ -99,7 +83,7 @@ We aim to have product listings published with the concept of versions, allowing *Tier Description* is what you see once users get entitled to a plan. For instance, in https://hub.docker.com/images/openmaptiles-openstreetmap-maps/plans/f1fc533a-76f0-493a-80a1-4e0a2b38a563?tab=instructions `A detailed street map of any place on a planet. Evaluation and non-production use. Production use license available separately` is what this publisher entered in the Tier description *Installation instructions* is documentation on installing your software. In this case the documentation is just `Just launch the container and the map is going to be available on port 80 - ready-to-use - with instructions and list of available styles.` (We recommend more details for any content that's a certification candidate). -### How can I remove a submission? I don’t want to currently have this image published as it is missing several information. +### How can I remove a published product? If you would like your submission removed, let us know by contacting us at publisher-support@docker.com. @@ -133,9 +117,9 @@ For instance, if you have a `Developer` Plan, that is mapped to repositories sto ### What options are presented to users to pull an image? We provide users the following options to access your software -* logged-in users. -* users who have accepted ToS -* all users (including users without Docker Identity) +* Logged-in users +* Subscribed users only (requires ToS acceptance) +* All users (including users without Docker Identity) Here is a [screenshot](https://user-images.githubusercontent.com/2453622/32067299-00cf1210-ba83-11e7-89f8-15deed6fef62.png) to describe how publishers can update the options provided to customers. ### If something is published as a free tier, for subscribed users only, does a user need to explicitly click Accept on the license terms for which we provide the link before they can download the image? @@ -158,16 +142,8 @@ from Docker Hub. The container may continue running. If you have a licensing scheme built into the container, the licensing scheme can be a forcing function and stop the container. (_We do not build anything into the container, it is up to the publisher_). -### How does a customer transition from a Trial to a Paid subscription? Question assumes these are two separate pulls from Docker Hub, or can they just drop in a license through Docker Hub? - -Publisher can provide two different tokens or let customers use the same token -and internally map the customer to a paid plan vs a free trial. - -### What are Docker Hub pricing plans like? Can I have metered pricing? - -As a publisher you can charge a subscription fee every month in USD. The amount -is determined by you. We are working on other pricing options. If you have -feedback about pricing, send us an email at publisher-support@docker.com +### Does Docker Hub offer a Subscription service, handle our invoicing, payments, etc? What happened to Pay-via-Docker? +Docker has deprecated the Pay-via-Docker subscription service. At this time, Docker Hub only supports distribution of content, under the BYOL Ungated model. In the future, we intend to release BYOL Gated functionality as well. If neither of these options will work for your product and licensing structure, please do inform your partner manager to help guide our feature prioritization. ### How does Docker handle Export control? Can individual countries be specified if differing from Docker's list of embargoed countries? @@ -180,16 +156,15 @@ specific groups. Send us an email at publisher-support if you have questions ### Where can I view customer insights? -Analytics reports are only available to Publishers with Certified or Commercial -Content. Go to https://hub.docker.com/publisher/center and click on "Actions" +Analytics reports are only available to Publishers with Certified. Go to https://hub.docker.com/publisher/center and click on "Actions" for the product you'd like to view analytics for. Here is a [screenshot](https://user-images.githubusercontent.com/2453622/32352202-6e87ce6e-bfdd-11e7-8fb0-08fe5a3e8930.png). -### How do metrics differentiate between Free and Paid subscribers? +### How do metrics differentiate between the different Pull Requirement options? The Analytics reports contain information about the Subscriber and the relevant product plan. You can identify subscribers for each plan -for each product. +for each product. Only anonymous information is available to our publishers. If you'd like the opportunity to receive Lead information, Subscribed Users Only will need to be selected as the pull requirement. Please review the Technology Partner Program guide, and consult with your partner manager, for more information on Lead Generation plans. ### Can I preview my submission before publishing? @@ -208,3 +183,16 @@ Yes ### Can I have a publish by date for my content? Not yet. This is a planned enhancement, but we have no specific availability date at this time. +In lieu of an automated approach, you may coordinate publication timeline directly with your partner manager. + +### Can I convert my Hub Community profile to a Verified Publisher profile? + +No, at this time you will need to separately sign up to become a Verified Publisher. Following that, you may migrate or re-publish your public repo's under the new Verified Publisher profile. + +### Once I've completed the process to become a Verified Publisher with my partner manager, how do I get access to the Publisher Portal? + +You will need to apply for access. Please either follow [this direct link](https://hub.docker.com/publisher/center) or click the "Publisher Center" link at the bottom of any Docker Hub page. Please note, that you will need to be logged in with a DockerID in order to see this link. + +### What kind of DockerID should I use to publish my content? + +Publishing should be done with an [Organization level DockerID](https://docs.docker.com/docker-hub/orgs/). We recommend that this account utilize a shared alias with your corporate email account and only individual DockerIDs with company email are added to that organization. diff --git a/docker-hub/upgrade.md b/docker-hub/upgrade.md index 6a0de8db5ee..d94e2ef75ba 100644 --- a/docker-hub/upgrade.md +++ b/docker-hub/upgrade.md @@ -1,12 +1,12 @@ --- description: Upgrading your Docker Hub Plan keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation -title: Upgrade your Plan +title: Upgrade your plan --- User and organization accounts maintain separate Docker Hub billing profiles. -### Upgrade your personal plan +## Upgrade your personal plan Docker Hub includes one private Docker Hub repository for free. If you need more private repositories, you can upgrade from your free account to a paid @@ -14,14 +14,63 @@ plan. To upgrade: 1. Visit the [Plans Page](https://hub.docker.com/account/billing-plans/) -2. Click **Change Plan** +2. Click Change Plan 3. Select your plan and provide your payment information to upgrade ![Upgrade Plan](images/index-upgrade-plan.png) -### Upgrade your organization's plan +## Upgrade your organization's plan To upgrade an Organization's plan: 1. Visit the [Plans Page](https://hub.docker.com/account/billing-plans/) 2. Change the selected account to your Organization whose plan you'd like to upgrade ![Change Account](images/upgrade-change-account.png) -3. Click **Change Plan** ![Change Plan](images/upgrade-change-plan.png) +3. Click Change Plan ![Change Plan](images/upgrade-change-plan.png) + + +## Docker Hub repo plan billing FAQ + +### What forms of payment do you accept? + +The Docker Hub accepts Visa, MasterCard, American Express, and Discover credit +cards. We do not accept ACH, EFT, or PIN-based debit card transactions at this +time. + +### What currencies do you accept? + +Docker is a US-based company, and bills in US Dollars (USD). This keeps our +pricing stable and consistent, rather than fluctuating with exchange rates. + +### When do you charge my credit card? + +We automatically charge your credit card on the first day of your billing cycle +each month, and the charge comes from Docker, Inc. Your billing cycle is a +30-day period starting on the day you subscribe. + +### What do I do if my payment fails? + +If your payment failed because the card expired or was canceled, you need to +update your credit card information or add an additional card. + +Click the user icon menu in the upper right corner, and click +**Billing**. Click the **Payment methods** tab to update your credit card and +contact information. + +If you are updating the card details for an organization, be sure to select the +organization name from the **Account** menu before updating the information. + +### How does cancellation work? Do you offer refunds? + +You can cancel a subscription at any time, however you are still billed +for the full month, and have access to the subscription content until the end of +that billing period. + +We do not offer refunds. If you believe that you've been billed in error, +contact our [Billing Support team](mailto:billing@docker.com). + +### How do I download the licenses my organization has purchased? + +You can view and download all you active licenses for an organization from the +**Subscriptions** page. + +Click the user icon menu at the top right, choose **My Content** and then +select the organization from the **Accounts** drop down menu.