catalog-update-private.md

copyright	lastupdated	keywords	subcollection
years 2020, 2021	2021-09-22	catalog, private catalog, update, private catalog product, update version, versions	account

{:shortdesc: .shortdesc} {:codeblock: .codeblock} {:screen: .screen} {:tip: .tip} {:note: .note} {:important: .important} {:go: .ph data-hd-programlang='go'} {:javascript: .ph data-hd-programlang='javascript'} {:java: .ph data-hd-programlang='java'} {:python: .ph data-hd-programlang='python'} {:ui: .ph data-hd-interface='ui'} {:cli: .ph data-hd-interface='cli'} {:api: .ph data-hd-interface='api'} {:terraform: .ph data-hd-interface='terraform'} {:external: target="_blank" .external}

Updating your software

{: #update-private}

To update the software that's in your private catalog, you can add a new version or update and republish an existing version. {: shortdesc}

Before you begin

{: #prereq-update}

To complete this task, you need to be assigned the editor role on the catalog management service. For more information, see Assigning users access.

Update an existing version by using the console

{: #update-editor-offering} {: ui}

The following steps walk through an example of making updates to a product's readme to show the complete process for updating an existing software version.

1. Go to Manage > Catalogs > Private catalogs, and select your catalog from the list.
2. Click the name of your software product.
3. Select Private products to navigate to the list of products that are in your private catalog.
4. Click the Actions icon , and select Edit.
5. Click the Edit readme tab.
6. Click the Edit icon , add a new line of text to the Introduction section, and click Update.
7. Click the Actions icon , and select Merge changes to publish the updated version to your account.

Update an existing version by using the CLI

{: #update-version-cli} {: cli}

Complete the following steps to create a draft version, update it, and merge the changes to the current version of your software.

You need the version locator for your software. To find it, run the ibmcloud catalog offering list --catalog "your-private-catalog" command and search for the existing version number. {: important}

1. Create a draft version of your software.

   ibmcloud catalog offering create-draft --version-locator <VERSION_LOCATOR>

   {: codeblock}

2. Set another category.

   ibmcloud catalog offering add-category --catalog "your-private-catalog" --offering "your-software" --category "category-type"

   {: codeblock}

3. Merge the draft update to your software. This action merges the update to the version of your software that's published in your account.

   ibmcloud catalog offering merge-draft --version-locator **<VERSION_LOCATOR_OF_DRAFT_VERSION>**

   {: codeblock}

4. Search for the software in the {{site.data.keyword.cloud_notm}} catalog.

   ibmcloud catalog get --public | grep your-software

   {: codeblock}

Update an existing version by using the API

{: #update-version-api} {: api}

You can programmatically update a version by calling the Catalog Management API as shown in the following sample request. For detailed information about the API, see Catalog Management API{: external}.

String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
String label = "{label}";
String shortDesc = "{shortDesc}";
ReplaceOfferingOptions replaceOptions = new ReplaceOfferingOptions.Builder().catalogIdentifier(catalogID).id(offeringID).offeringId(offeringID).label(label).shortDescription(shortDesc).rev(revision.rev()).build();
Response<Catalog> response = service.replaceOffering(replaceOptions).execute();
System.out.println(response.getResult());

{: codeblock} {: java}

vcatalogID = "{catalogID}";
offeringID = "{offeringID}";
revision = "{revision}";
label = "{label}";
shortDesc = "{shortDesc}";
response = await service.replaceOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'id': offeringID, 'rev': revision, 'label': label, 'shortDescription': shortDesc});
console.log(response);

{: codeblock} {: javascript}

catalogID = "{catalogID}"
offeringID = "{offeringID}"
revision = "{revision}"
shortDesc = "{shortDesc}"
response = self.service.replace_offering(catalog_identifier=catalogID, offering_id=offeringID, id=offeringID, rev=revision, label=label, short_description=shortDesc)
print(response)

{: codeblock} {: python}

catalogID := "{catalogID}"
offeringID := "{offeringID}"
label := "{label}"
shortDesc := "{shortDesc}"
revision := "{revision}"
updateOptions := service.NewReplaceOfferingOptions(catalogID, offeringID)
updateOptions.SetID(offeringID)
updateOptions.SetLabel(label)
updateOptions.SetShortDescription(shortDesc)
updateOptions.SetRev(revision)
_, response, _ := service.ReplaceOffering(updateOptions)
fmt.Println(response)

{: codeblock} {: go}

Update an existing version by using Terraform

{: #update-editor-terraform} {: terraform}

You can update an existing version of your software by using Terraform.

1. To install the Terraform CLI and configure the {{site.data.keyword.cloud_notm}} Provider plug-in for Terraform, follow the tutorial for Getting started with Terraform on {{site.data.keyword.cloud}}. The plug-in abstracts the {{site.data.keyword.cloud_notm}} APIs that are used to complete this task.

2. Create a Terraform configuration file that is named main.tf. In this file, you add the configuration to update your software version by using HashiCorp Configuration Language. For more information, see the Terraform documentation{: external}.

   The following example accesses the software version by using the cm_version resource, where offering_id identifies the software.

   resource "cm_version" "cm_version" {
   catalog_identifier = "catalog_identifier"
   offering_id = "offering_id"
   zipurl = "zipurl"
   }

   {: codeblock}

   For more information, see the argument reference details on the Terraform Catalog Management{: external} page.

3. Initialize the Terraform CLI.

   terraform init

   {: codeblock}

4. Create a Terraform execution plan. The Terraform execution plan summarizes all the actions that need to be run to update the version.

   terraform plan

   {: codeblock}

5. Update the version.

   terraform apply

   {: codeblock}