Service Catalog

A Service Catalog enables your organization to create and manage catalogs of applications that are approved for use in your tenancy. These applications are offered through marketplace in the form of image and stack listings. Applications can be a public application available on marketplace or a private application offered within the organization. The Service Catalog allows organizations to centrally manage applications and helps achieve consistent governance and compliance requirements. Approved or restricted sets of applications can reduce risks of misuse or overspending by end users, giving administrators peace of mind. End users can quickly deploy only approved applications that follow constraints set by the organization.

Required IAM Policy

To use Oracle Cloud Infrastructure, you must be granted security access in a policy  by an administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don’t have permission or are unauthorized, verify with your administrator what type of access you have and which compartment  to work in.

If you're new to policies, see Getting Started with Policies and Common Policies.

For administrators, the following policies enable the creation of applications in a Service Catalog and provide access to those applications to users. For any policies, if you want to reduce the scope of access to a particular compartment, specify the compartment instead of the tenancy.

  • The following policy gives the specified example group the ability to list, view, create, update, delete, or move Private Applications in all compartments.

    allow group CatalogAdmins to manage private-applications in tenancy
  • The following policy gives the specified example group the ability to list, view, create, update, delete, or move Service Catalogs in all compartments.

    allow group CatalogAdmins to manage service-catalogs in tenancy
  • The following policy gives the specified example group the ability to browse and launch Service Catalog applications in all compartments:
    allow group CatalogUsers to inspect service-catalog-contents in tenancy
  • The following policy gives the specified example group the ability to browse and launch applications only from within a specific service catalog:
    allow group CatalogUsers to inspect service-catalog-contents in tenancy where service-catalog.id='ocid1.servicecatalog.oc1.iad.aaaaaaaaexampleocid'
  • The following policy gives the specified example group the ability to browse and launch applications only from within those service catalog which are hosted in the compartment Project-A:
    allow group CatalogUsers to inspect service-catalog-contents in compartment Project-A

If you need to write more restrictive policies, see the policy reference on which these policies were based: Details for the Marketplace Service and Details for the Core Services, as needed.

Working with Service Catalogs

This section describes how to create, edit, view, and delete Service Catalogs.

Using the Console

To create a Service Catalog
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Catalog Manager. The Catalog Manager page appears, showing the list of Service Catalogs.
  2. You can select a compartment with the Compartment drop-down list in the List Scope section on the left side of the page.
  3. Click the Create Service Catalog button at the top of the list of Service Catalogs. The Create Service Catalog dialog appears.
  4. Enter the name of the Service Catalog in the Name text box.
  5. Select the compartment using the Create in Compartment drop-down list.
  6. You can optionally select one or more Marketplace or Private applications to share in this catalog from the Applications list:
    1. Select an application by clicking the check box next to it.
    2. You can type in a search term in the Search for applications text box at the top of the list.
    3. You can filter the list by selecting a filter from the available drop-down lists in the Filter section to the left of the list of applications.
  7. Click the Create button.
To view a Service Catalog's details
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Catalog Manager. The Catalog Manager page appears, showing the list of Service Catalogs.
  2. You can select the compartment scope of the displayed Service Catalogs with the Compartment drop-down list in the List Scope section on the left side of the page.
  3. Click on the name of the Service Catalog in the list. The Service Catalog's details page displays.
To update a Service Catalog
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Catalog Manager. The Catalog Manager page appears, showing the list of Service Catalogs.
  2. Click on the name of the Service Catalog in the list. The Service Catalog's details page displays.
  3. Click the Edit button.
  4. You can update the name of the Service Catalog by modifying the value in the Name text box.
  5. You can add or remove applications in the Applications list.
    1. You can search by name or filter the list by selecting one or more filters in Filter section to the left of the list of applications.
    2. Check or uncheck the box next to the application name that you want to include or remove.
  6. When you are finished, click Save Changes.
To delete a Service Catalog
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Catalog Manager. The Catalog Manager page appears, showing the list of Service Catalogs.
  2. There are two ways to delete a Service Catalog:
    1. From the list of Service Catalogs on the Catalog Manager page:
      1. Click the context menu icon to the right of the Service Catalog you want to delete, then click Delete.
      2. To confirm, click Delete again.
    2. From the Edit Service Catalog page:
      1. Click the Delete button.
      2. To confirm, click Delete again.
To view all Service Catalogs in a compartment
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Catalog Manager. The Catalog Manager page appears, showing the list of Service Catalogs.
  2. You can select a compartment with the Compartment drop-down list in the List Scope section on the left side of the page.
To move a Service Catalog application to another compartment
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Catalog Manager. The Catalog Manager page appears, showing the list of Service Catalogs.
  2. Click on the name of the Service Catalog you want to move. The details page for that Service Catalog appears.
  3. Click the Move Resource button.
  4. Select the destination compartment from the Choose New Compartment list, then click Move Resource.
Browsing and Launching Service Catalog Applications
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Applications. The Applications page appears, showing all of the marketplace listings and private applications available in the compartment.
  2. Click on the name of the application you want to launch. The Application Details page appears.
  3. Click the Launch button.
  4. For more information, see Working with Listings.

Working with Private Applications

This section describes how to create, edit, view, and delete Private Applications.

Using the Console

To create a Private Application
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Private Applications. The Private Applications page appears, showing the list of Private Applications.
  2. You can select a compartment with the Compartment drop-down list in the List Scope section on the left side of the page.
  3. Click the Create button at the top of the list. The Create Private Application dialog appears.
  4. Enter the name of the Private Application in the Name text box.
  5. You can add an icon by dragging and dropping the JPG or PNG file into the Application Icon box or by clicking the Browse link and selecting a file. If you don't provide an icon, a default icon is provided.
  6. Enter a short description in the Short Description text box.
  7. Enter a more detailed description in the Long Description text box. This description will be displayed to the user at launch time.
  8. Enter the version of the application into the Application Version field.
  9. Upload a Terraform configuration file by dragging and dropping the file into the Upload File Containing Terraform Configuration box or by clicking the Browse link and selecting a file.
    Note

    For guidelines on creating a Terraform configuration file, see https://docs.oracle.com/en/cloud/marketplace/partner-portal/partp/guidelines-stacks.html.
  10. Click the Create button.
To view a Private Application's details
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Private Applications. The Private Applications page appears, showing the list of Private Applications.
  2. Click the name of the Private Application that you want to view. The Private Application Details page appears.
To update a Private Application
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Private Applications. The Private Applications page appears, showing the list of Private Applications.
  2. Click on the Edit button.
  3. Update the name of the Private Application in the Name text box.
  4. Change the icon by dragging and dropping the JPG or PNG file into the Application Icon box or by clicking the Browse link and selecting a file.
  5. Update the short description in the Short Description text box.
  6. Update the detailed description in the Long Description text box. This description will be displayed to the user at launch time.
  7. Click the Save button.
To delete a Private Application
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Private Applications. The Private Applications page appears, showing the list of Private Applications.
  2. There are two ways to delete a Private Application:
    1. From the list of Private Applications on the Private Applications page:
      1. Click the context menu icon to the right of the Private Application you want to delete, then click Delete.
      2. To confirm, click Delete again.
    2. From the Edit Private Application screen:
      1. Click the Delete button.
      2. To confirm, click Delete again.
To view all Private Applications in a compartment
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Private Applications. The Private Applications page appears, showing the list of Private Applications.
  2. You can select a compartment with the Compartment drop-down list in the List Scope section on the left side of the page.
To move a Private Application to another compartment
  1. Open the navigation menu. Under the Solutions and Platform group, go to Service Catalog. Then, click Private Applications. The Private Applications page appears, showing the list of Private Applications.
  2. Click on the name of the Private Application you want to move. The details page for that Private Application appears.
  3. Click the Move Resource button.
  4. Select the destination compartment from the Choose New Compartment list, then click Move Resource.