Deployment

The site administration commands enable the efficient administration of the Astra web service. To this end, the astra tool needs to be executed on the machine hosting the Astra web service.

Per default, the tool assumes that the current working directory corresponds to the Astra tool web root directory, and it uses system environment variables or, if available, the environment variables set in the "web.config" file to retrieve credentials for accessing the keyvault. To override these defaults, the following options are provided to indicate which installation of the Astra web service should be acted upon:

  • [[-w|--webroot] path\to\wwwroot] the web root of the Astra tool.
  • [[-s|--site] website-name] the name of the IIS website under which the Astra tool is running. The web root and the corresponding path to "web.config" will be derived from that indication.

The following commands are available:

astra function-update

Usage:

  • astra function-update [-s website-name]

initiates an update of the azure function. If indicated, the "-l" option lists the available versions of the Azure function and quits. Example:

  • astra function-update -s astra updates to the latest Azure function release used by the Astra tool installed under the IIS site name "astra"

astra iis-update

Usage:

  • astra iis-update [-s website-name|[-w webroot]] [-l|--list] [-v versionstring]

initiates an update of the Astra tool. If indicated, the "-l" option lists the available versions of the Astra tool and quits. If indicated, the "-v" allows to filter for a version string to choose from the list of available versions. Per default, the latest version is downloaded. Examples:

  • astra iis-update -s astra updates to the latest Astra release used by the Astra tool installed under the IIS site name "astra"
  • astra iis-update -w C:\inetpub\wwwroot updates to the latest Astra release used by the Astra tool installed under the indicated webroot. Note that in this case, the application pool won't be stopped and restarted to ensure a smooth update.
  • astra iis-update -v v1.1 updates to the latest Astra minor release version "v1.1.*", using the current working directory as web root. Note that in this case, the application pool won't be stopped and restarted to ensure a smooth update.
  • astra iis-update -s astra -v v1.1 updates to the latest Astra minor release version "v1.1.*" under the IIS site name "astra".

astra keyvault-copy

Usage:

  • astra keyvault-copy [-s website-name|[-w webroot]] [-f All|Settings|Secrets] -t target-keyvault

Copy keyvault entries from the keyvault used by the Astra installation identified through the current working directory / "-s" or "-w" to the target keyvault with the name indicated by the parameter "-t". By default, only settings are copied. If user secrets should be copied as well, use "-f All".

astra keyvault-export

Usage:

  • astra keyvault-export [-s website-name|[-w webroot]] [-f All|Settings|Secrets] [-o out-file]

Export keyvault entries from the keyvault used by the Astra installation identified through the current working directory / "-s" or "-w" to an unencrypted file indicated by "-o" (default: "keyvault-dump.json"). By default, only settings are copied. If user secrets should be exported as well, use "-f All".

astra keyvault-import

Usage:

  • astra keyvault-import [-s website-name|[-w webroot]] [-f All|Settings|Secrets] [-i in-file]

Import keyvault entries from an export dump (indicated by "-i", default "keyvault-dump.json") into the keyvault used by the Astra installation identified through the current working directory / "-s" or "-w". By default, only settings are copied. If user secrets should be exported as well, use "-f All".

astra keyvault-clean

Usage:

  • astra keyvault-clean [-s website-name|[-w webroot]]

Remove obsolete settings which are no longer used by the Astra tool.

astra keyvault-set

Usage:

  • astra keyvault-set [-s website-name|[-w webroot]] --key key-name --value value`

Set a keyvault entry. Example:

  • astra keyvault-set --key STEP--StepBaseUrl --value https://customer.stepcloud.ch sets the step base url for the Astra installation when called from the Astra web root.