FAQ

Table of Contents

Contact

Kirthana Maguluri
kmaguluri@pivotal.io
Product Manager

Site Features

How should internal teams submit change or feature requests?

Reach out to Pivnet product manager via email or in person, or over the #Pivotal-network channel with details about the request: the problem the feature aims to solve, your feature request, and information about why it’s important.

How are change requests prioritized?

We’ll have a conversation to clarify the request, then the priority of a change request or feature is based on the value it will create to the users and to the business. Many of these priorities are determined during Re-Inceptions, which occur every 3-6 months.

How to create an account?

Visit the Pivnet homepage. Click on Register.

register_button

Products

Creating a new product

To create a new product on Pivnet, send an email to our Product Ops team - product_ops@pivotal.io. They’ll send instructions

Managing Product Pages

To get access to an existing product page in order to manage it or upload new releases to it, please send an ask ticket (ask+cf@pivotal.io).

When a new product admin is added, we will check to see who can be removed from the list, in order to limit security risks and keep a closer control over who has management rights to products.

Creating a product alias

A product alias allows Pivnet users to search for a product in the Pivnet front page search bar using a product's informal name. (For example, to find Single Sign-On for PCF a user can search the alias sso)

A product admin can request a product alias in the #Pivotal-Network slack channel. The request should include the product slug, the requested alias, and the reasoning for the addition of the alias.

After verifying the requester is an admin on the product, a Pivnet Engineer will follow the steps here to create the alias.

Changing a Product Slug

A product slug is a unique identifier for the product. Every slug is associated with just one product. Through the method detailed here, a product can have more than one slug.

A product admin may change the product slug. Navigate to the product admin page: https://network.pivotal.io/products/{CURRENT_PRODUCT_SLUG}/admin and click on the Edit Product Information link. Enter the desired slug in the Product Slug field.

The newly created slug will work. The former slug will also work. Beware: the former slug can now be chosen by another product. Once this is done, the slug will no longer direct to the original product.

Changing a Product Suite

A product suite is like any other product: the user needs to be an Product Admin to manage the suite. Our Product Manager can add the product in the suite and give you admin rights so you can make any required changes.

Releases

Making a change to a release that is already visible to All Users

When a release has been made available to all users, the release and all associated files are made immutable. Teams will no longer be able to alter metadata, switch the license, or make other changes.

In the unfortunate case that a team has made a release available and discovered that some change is imperative, the team should fill out this form. After completing the form, the team should announce in the #pivotal-network slack channel that the form has been completed. The Pivnet team will make the release mutable.

Pivnet Team Member Action: Open the admin view of the request form. Click on Responses and then Individual and open the latest response. Verify that the request comes from an admin of the specified product. If so, go to the Pivnet GUI and open Admin Tools. Edit the product in question to make it mutable. In a slack thread on #pivotal-network, let the requester know that their release is now mutable. Include a message to this effect, "Please let us know when you are done making changes. The Pivnet team defaults to making releases immutable again in 24 hours. If you need more time, please let us know." Create a chore in tracker to make the product immutable; block the story for 24 hours.

Giving someone access to Releases that Are Not Available to All Users

Pivnet releases are either available to All Users, Admins Only, or Specific User Groups. If there’s a specific release that you or your customer needs early access to, you or your customer will need to be added to a User Group.

To get access to a User Group in order to get access to early releases, please send an ask ticket (ask+cf@pivotal.io) OR reach out to the team responsible for the product in question.

The process to add users to the EOGS User group on PivNet to get access to N-3 releases can be found here.

Controlling Access to Releases: What Early Access User Groups should I use for my Limited Availability release?

As a Product Admin releasing software to Pivotal Network, you may want to create a release and make it only available to selected user groups.

  1. Edit the release and click ‘Selected User Groups Only’ for Availability
  2. Associate one or more groups with the release.

IMAGE HERE

There are three ‘General’ groups available to Product Admins setting Release visibility: 1. Pivotal Internal Early Access: This group contains many internal Pivotal employees, including much of the field. 1. Pivotal Customer Early Access: This group primarily contains external customers who would like early access to pre-GA products

Besides these cross-cutting, general groups, there are several customer-specific groups to choose from when setting visibility on a product. It is up to the Product Admin to decide who should see what release, when. If a group does not meet your needs as a Product Admin, please send an ask ticket (ask+cf@pivotal.io) about creating a new one.

(Last updated: October 9, 2017)

Finding if Changes Have Occurred

If a user would like to know if changes have been made to a release, please send an ask ticket (ask+cf@pivotal.io). A site admin will be contacted.

If a site admin needs to know when changes were made to a release:

  1. Log in to Pivnet.
  2. From the upper right menu, select Admin Tools.
  3. From the top tab selection, choose Releases.
  4. For the release in question, click on view.
  5. In the latter half of the page, the Changes table will list all changes, along with their timestamps.

Adding an OSL file to a release

Visit the “Product Files” tab for your product. Create a new file by uploading the OSL file, making sure to indicate that the “File Type” is “Open Source License” (SHA256 is not used for this file type). Once uploaded, navigate to the “Releases” admin tab for your product and add the OSL file to all applicable releases. If you’ve done it correctly, when viewing your product release on PivNet, you should see a “LICENSE FILES” section near the bottom of the “Release Details” box on the right side and the file will automatically be made available publically to customers at https://network.pivotal.io/open-source.

Hiding Releases

If a product owner wants to hide a release that has already been set to the "All Users" availability then please follow the steps mentioned in making a change to a release that is already visible to All Users. It is recommended to change the release availability to "Admins Only".

Checking for New Releases

To check for new releases, please check our web feed at https://network.pivotal.io/rss

Files and File Groups

Associating new Product Files to a File Group

A product admin can add product files to a file group using either the website GUI or the API V2 endpoint.

Using the website: Navigate to https://network.pivotal.io/products/{YOUR_PRODUCT_SLUG}/product_files and click on the existing File Group. Select any product files that should be included in the group.

Using API V2: See the API documentation on PATCH /api/v2/products/:product_slug/file_groups/:file_group_id

User Groups

Creating a New User Group

If a user would like a new user group, please send an ask ticket (ask+cf@pivotal.io) specifying the requested group name, the group description/purpose and the email addresses of invitees. A site admin will be contacted.

For Site Admins:

Using the website: A site admin can create new groups. On the User Group page click on the button Create New User Group. Input the name, description and invitees to the group.

Using API V2: See the API documentation on POST /api/v2/user_groups

Adding a User to a User Group

Viewing and managing user groups on the website: Most users can view all user groups by clicking on the upper-right dropdown menu on the Pivotal Network website and selecting User Groups. All user groups managed by the user will be displayed with links to view, add and remove members. All user groups not managed by the user will be displayed without management links. All user groups will display the names of up to three administrators for that group.

Adding or removing members if you are an internal Pivotal user: If you manage the user group, see above. Otherwise, either contact one of the administrators for that group or send an Ask ticket (ask@pivotal.io).

Adding or removing members if you are an external user: Please ask your Platform Architect or other internal Pivotal contact.

Using API V2: See the API documentation on PATCH /api/v2/user_groups/:user_group_id/add_member

Notifications

Overview

Email notifications

Pivnet users can receive product security alerts by clicking the "Get Email Alerts" button on the product page. Users will receive an email notification each time there is a security alert that is associated with the product.

Users can stop receiving email notifications by clicking the "Getting Email Alerts" button.

Image here

Example of a security alert email notification, created by a Product Owner or Release Manager

In-App Security Alerts

If a user is receiving email alerts for a product, they will receive in-app notifications for the product. In-app notifications are triggered when a security alert has been issued for any of the files that the user has downloaded.

Image here

In-app security notifications are represented with a yellow triangle. In-app notifications are also displayed on the product page.

Image here

In-app notifications are also displayed on the product page.

How can we send Tech Advisory notifications to customers?

PivNet notifications can be triggered by a release manager issuing a CVE alert for one or more product files. We call this "product alert". This triggers an email as well as an in-app notification.

When a user downloads something from a product, they automatically begin receiving email alerts for the product.

Will the customer only receive a notification for the product they purchased?

If the customer has clicked "Get Email Alerts" for the product on PivNet or downloaded at least one file from the product page on PivNet, they will receive notifications about CVE alerts issued by the product's release manager through PivNet.

Posting alert notifications from PivNet
  1. The release manager goes to the product pages and clicks "Actions" > "Create Alert". Click here for screenshot.

  2. The release manager inputs information about the alert into the "Create Alert" form and hits "Send" to send the alert via email to all users who have downloaded the affected file(s). Click here for screenshot.

  3. PivNet users (paying and non-paying customers) who have downloaded the files addressed in the alert receive an email. Click here for screenshot.

At this time, there is no way to customize the design for these alert notifications, or preview them before sending out.

How can I style text in a notification/alert?

The Create Alert page accepts markdown for the Details and Recommended Action sections. Admins can bold text for emphasis, create numbered lists or lists with bullets, and can add links.

Usage Reports

How can I see usage reports for my product?

Via GUI: As a Product Admin, you can view download reports for your product(s). To do so - login to Pivnet and click through to the reports section:

Image here

Click on the icon to download the CSV report.

Image here

Via API: You can also access these reports directly via the API. Reports are currently available in CSV format, but will soon be available in JSON format.

Pivnet Concourse Resource

The best way to find out when new releases of products are released is to build a Concourse pipeline that uses the Pivnet Resource. This resource can be used to poll for new releases of products that match several desired criteria (e.g.: regular expression on filename, release type, etc.) and can also be used to upload newly assembled releases to Pivnet for further distribution. Please see the documentation for the Pivnet Concourse Resource itself for more information.

EULAs

How can we mandate the attachment of a EULA when posting the bits on PivNet (this is a requirement for GA)?

Currently, this is a required field on the release. It’s impossible to create a release without associating the product with a EULA. Thus, all bits posted to a release page are covered by a EULA.

How do I know which EULA to use for my release?

You can contact Product Operations (product_ops@pivotal.io) to discuss legal agreements.

How can I add a new EULA or edit the text of an existing EULA?

To create or modify a EULA, please contact Product Operations (product_ops@pivotal.io).

How do I create a release for a non-production environment?

For questions about production vs. non-production EULAs, please contact Product Operations (product_ops@pivotal.io).

How can I preview a EULA before associating it with my release?

You can associate the target EULA with the product “Test Product – Admins only”. You can then visit the product page and download a file to see the EULA.

Token Problems

There are many reasons why your token is no longer working. The suggested token route is to use a refresh token. These tokens are retrieved via your profile screen in Pivnet UI. Try to generate a new refresh token and use that. It may solve your problem.

Downloading

What hosts should I whitelist for PivNet Downloads?

If you are downloading from behind a firewall, whitelisting d13k9s5899twdr.cloudfront.net will allow downloads to complete.