Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Summary: step-by-step instructions for updating the CAST Extend Service with new content.

Introduction

The CAST Extend Service is delivered with a "stock" set of CAST AIP extensions (the full list for each release of CAST Extend Service can be found in the relevant Release Notes). This stock set of extensions can be enhanced to meet your organization's requirements, for example:

  • you can add extensions that are not provided in the stock set
  • you can include more recent releases of extensions that are already provided in the stock set

The process of updating the set of extensions available in the CAST Extend Service is as follows:

  • Create a new package in https://extendng.castsoftware.com which contains the extensions you require
  • Download the package using a browser
  • Upload the package to update the CAST Extend Service automatically:

When the CAST Extend Service is updated with a new package of extensions, a "merge" is actioned, rather than a "delete and add". This means that no extensions are ever removed, i.e.:

  • Any extensions that already exist in CAST Extend Service but do not exist in the new package will remain as they are in CAST Extend Service
  • Any extensions that already exist in CAST Extend Service at a given version number will remain as they are in CAST Extend Service when:
    • an older version of the same extension is added to the package (both versions will be available for use)
    • a newer version of the same extension is added to the package (both versions will be available for use)
    • an older and a newer version of the same extension are added to the package (all three versions will be available for use)
    • the same version of the extension is added to the package

What happens when the CAST Extend Service does not contain an extension required for analysis?

The analysis will fail during the "Content discovery" step with the following error:

Update process

Create and download a new package

Log in to https://extendng.castsoftware.com and click the Create Package located in the top right corner next to the profile icon:

The following screen will be displayed:

This screen shows:

  • on the left: a list of predefined "bundles" that are available for use
  • on the right: a list of the extensions (and version number) included in the bundle

Choose the bundle(s) you wish to include in the update package by toggling the slider to the enabled position:

Finally click the Generate Update button to build the package.

The following message will be displayed:

You will receive an email (sent to the email address associated with your CAST Extend login) when your package is ready to download. Click the Download button to return to extend.castsoftware.com where you can start the package download:

  • A package containing only default extensions is generally around 500MB
  • Package files will use the .extarchive file extension

Upload the package to CAST Extend Service

Via AIP Console

If you are using the CAST Extend Service with AIP Console, the process of updating the CAST Extend Service is handled automatically by AIP Console. Login to AIP Console with a user account that already has the Admin role and switch to the Admin Center:

Now move to the Settings panel and expand the Extend Offline options (if you do not see this option, AIP Console is not configured to use an on premises CAST Extend Service):

Drag and drop your downloaded package in to the options screen, or click the button to choose the .extarchive file directly. The package will then be uploaded and added to the CAST Extend Service automatically and all new extensions added to the package will be available immediately.

Via the CAST Extend Service API and curl

CAST Extend has a built in API that can be accessed in a manner of ways. It is therefore possible to upload a new package using the API, for example with curl:

curl -F "data=@<path_to_file.extarchive>" http://<server>:<port>/api/update
curl option -FThis causes curl to POST data using the Content-Type multipart/form-data. See https://curl.haxx.se/docs/manpage.html#-F
<path_to_file.extarchive>The path to the .extarchive package file.
<server>

Form part of the URL to your on premises CAST Extend Service. For example:

  • <server>: the local server on which CAST Extend Service is installed.
  • <port>: the port number which CAST Extend Service runs on. This is determined during the installation (default port number is set to 8085).
<port>

For example:

curl -F "data=@D:\downloads\b2b430df976c412ca29e799fff0fd86e.extarchive" http://cast_extend:8085/api/update
  • No labels