Publish a private (unpublished) RightScale component using the Publishing Assistant.
Important! The Publishing Assistant may be used when publishing any RightScale component (ServerTemplate, RightScript, Macro or MultiCloud Image). However, EULAs only apply to ServerTemplates, not other components. The tutorial below uses a ServerTemplate as to include every step of the Publishing Assistant process.
Table of Contents
Using the Publishing Assistant is very intuitive. This tutorial will highlight the multiple phases of using the Publishing Assistant:
- Organization - First time publishers will need to provide information about their organization. (Only seen the first time you publish a component.)
- Sharing - Specify the target audience you want to share with.
- Descriptions - Enter the short and long descriptions.
- EULAs¹ - End User License Agreements. You can use an existing EULA or create a new one from within the assistant.
- Preview - Preview what a user would see prior to actually publishing to the MultiCloud Marketplace.
While transitioning through these phases of the Publishing Assistant, you are also free to navigate to the previous or next phase at any time. The phase arrows are also actionable (Shown in below diagrams for each phase.)
For more information about sharing, please see Sharing RightScale Components.
¹ Only applies when publishing ServerTemplates.
RightScale's Publishing Assistant wizard will walk you through the process of publishing your component(s).
Publish to MultiCloud Marketplace
The first step in the sharing process is to determine which RightScale component you want to publish to the MultiCloud Marketplace. Users will need to have access to the MultiCloud Marketplace ('library' user role privileges) in order to view and import/subscribe to a shared component. You can only publish private components to the MultiCloud Marketplace. (i.e. You cannot import a premium ServerTemplate that's published by a different account and then re-publish it to the MultiCloud Marketplace.)
- Go to the private component in your local collection that you want to share. (e.g. Design -> ServerTemplates -> View Local)
- Be sure to select the correct revision of that component that you want to share. As a best practice, you should only share committed (static) revisions of a component. Also make sure that you haven't previously published it. The component should be listed as "unpublished" under the component's Info tab. You should only share a HEAD version under certain circumstances. The ability to publish a HEAD version is only supported for RightScale accounts that are enabled for private sharing. You cannot publicly share a HEAD version of a component. When you publish a component to the MultiCloud Marketplace, only the selected revision or HEAD version will be published. (i.e. Previous revisions of that component will not be published.)
- Click the Publish to MultiCloud Marketplace action button. (Note: If this button is not displayed, you do not have the 'publisher' User Role Privilege in the RightScale account or if you are looking at a HEAD revision and your account does not support private sharing.)
- You must read and agree to RightScale's EULA before continuing the publishing process.
- Next, you will need to specify the visibility of your component. This selection controls who can browse and find your component in the MultiCloud Marketplace. (In a later step you will specify which accounts have access to import the component.)
- Publish to the Public MultiCloud Marketplace Catalog - Make this component publicly visible to everyone in the MultiCloud Marketplace. Unless your account is enabled for private publishing, only committed revisions can be publicly shared. (Note: Components will be indexed by search engines.)
- Share privately - Make this component only visible in the MultiCloud Marketplace to specific RightScale accounts with whom you've granted access via Account Group Invitations. Users will be able to view the component in the MultiCloud Marketplace under Categories -> Shared. Note: You must have a Premium account (or better) for private sharing.
If you are publishing for the first time, you must provide the following information about your publishing organization. Later, you can edit this information under Design -> Account Library -> Your Publishing Organization. The 'Organization' tab appears the first time a user publishes from your account.
- Organization Name (required) - In the MultiCloud Marketplace, the organization name will denote who published the component. Each account can only have one defined publishing organization. Several characters are not allowed in the namespace : ; \ / > < & , .
- Organization Email (required) - When someone leaves a comment on one of your shared components, notifications will be sent to this email address (if enabled).
- Logos - Depending on the view in the MultiCloud Marketplace, large and small logos will appear next to the component.
- Support Information - Publishers are responsible for supporting their shared components. Be sure to provide helpful links and contact information that will be useful for your users. The provided support information will be displayed for each shared component regardless of the account group.
- Welcome Message - The welcome message will be shown when an Account Group Invitation is accepted.
The "Sharing" section allows you to control who can import your component.
Specify your sharing preferences. Remember, when you publish a ServerTemplate, any (unpublished) private RightScripts, MultiCloud Images, and RepoPaths that are used by the ServerTemplate are implictly shared to guarantee the usability of the template itself. Click the View ServerTemplate components link to see what other components will be implicitly published.
- All RightScale Accounts - The component can be imported into any RightScale account. Note: Public publishing must be enabled in the publishing account. Contact your RightScale account manager to enable public publishing for your account.
- Specific Accounts - The component can only be imported into specified RightScale accounts. You can either select an existing Account Group(s) or create a New Account Group. Note: You must select at least one Account Group, however it can be empty. (i.e. Specific RightScale accounts have not been added to the Account Group.)
- Publishing Only for RightScale Paid Accounts - If your account is enabled for private publishing, you can also select the "RightScale Paid Customers" Account Group which makes the component importable ONLY into paid RightScale accounts (Standard and above). Only users with credit cards on file are able to import ISV templates that require payment (contact your account manager or email@example.com for clarification). NOTE: Select this option if you are an ISV publishing a pay-per-use RightScale ServerTemplate unless otherwise instructed by your RIghtScale account contact.
The "Comments" section allows you to control the comment feature in the MultiCloud Marketplace.
- Allow users to leave comments on this ServerTemplate - If checked, users will be able to leave comments about your component in the MultiCloud Marketplace. Only users who are logged into the Dashboard can leave comments.
- Email me when a user comments on this ServerTemplate - If checked, an email notification will be sent to the provided Organization Email address. (Design -> Account Library -> Your Publishing Organization)
Click the Descriptions action button to proceed to the next step.
Fill out the Short and Long Descriptions for the component. For your convenience, both description fields are pre-populated with the ServerTemplate's current description. If you have published an earlier revision, the fields are pre-populated with the previously entered short and long descriptions. However, since these description fields will be saved in the MultiCloud Marketplace's database, you can actually provide different descriptions. Note: The provided descriptions will appear in the MultiCloud Marketplace for all previously shared revisions of that component.
You can update the "New Revision Notes" as well, which are prepopulated with the component's Commit message for the selected revision.
Revision Notes are similar to commit messages in the Dashboard. They will be seen at the bottom of the shared component in the MultiCloud Marketplace. As a best practice, you should provide useful information about any changes, bug fixes, new features, especially if there's a previously published revision of that component in the MultiCloud Marketplace.
Categories allow users to more easily search for your publication in the MultiCloud Marketplace. The selected categories will be applied to all revisions of your publication. You can add multiple categories.
- Markdown syntax is supported
- Hover over the blue information icon for additional help
- Character limitations are updated in real time as the fields are populated
Click the EULAs action button to proceed to the next step.
Reminder: EULAs currently apply to ServerTemplates only. This phase is not part of the Publishing Assistant when publishing other RightScale components (RightScripts, Macros or MCIs).
- EULAs can be managed outside of the Publishing Assistant. Simply select which EULA(s) should be attached to the ServerTemplate you are going to publish.
- You can also create and add a new EULA directly from within the Publishing Assistant.
- Click the New EULA action button
- Fill out the EULA Name and Text. Markdown Syntax is supported.
- Preview the EULA. Don't forget to select Save & Attach prior to continuing.
- Note: EULAs are not required when publishing RightImages, RIghtScripts, or Macros indepdendently from a ServerTemplate.
Click the Preview action button to proceed to the next step.
If everything looks correct, click the Publish action button.