Artifacts are user defined resources and scripts that can be referenced and executed in blueprints. Supported artifact types include:
This article describes the steps required to manage artifacts.
This section describes the steps required to access Artifacts.
Administrative Users should jump ahead to the next step Accessing Artifacts (Administrative Users).
- User owns artifacts
- User has been assigned permissions to manage artifacts
- Login in the the Broker UI
- Navigate to Composer > My Artifacts
- A list of Artifacts is displayed within the Scripts and Files tabs, which include artifacts owned by the user or has the Manage permission assigned to the user
- Click on the Artifact name or the Edit button to view details of the artifact
Accessing Artifacts (Administrative Users)
This section describes the steps required to access Artifacts as an administrative user.
Non-administrative users should refer to the previous step Accessing Artifacts.
- Administrative access to the Broker UI
- Login in the the Broker UI as an administrative user
- Navigate to Manage > Artifacts
- A list of Artifacts is displayed within the Scripts and Files tabs
- Click on the Deployment name or the View button to view details of the Deployment
The following lists management operations available for artifacts.
|Edit||Modifies the artifact's properties|
|Download||Downloads the artifact to the local computer. eg. For external editing|
|Publish/Unpublish||Makes the artifact item available/unavailable for use within the blueprint composer|
Removes the artifact
Note: For Broker-managed artifacts, this action deletes the artifact object. For Repository-manages artifacts, the Broker reference to the repository item is removed without deleting the object from the repository.
Adding/Creating an Artifact
Artifacts can be created directly within the Broker, uploaded, or imported from an external repository.
Refer to the relevant procedure steps for detailed instructions:
The Details tab allows artifact owners and administrators to list and edit the artifact's properties. For script artifacts, it also allows editing of the script.
The following lists properties for script artifacts:
- Name: A friendly name for the script artifact
- Filename: The file name of the stored script artifact
- OS Family: The Operating System family which can run the script
- Icon: An icon image used to represent the artifact
- Description: A description for the script artifact
- Script: The editor area for composing the script - a script file can also be dragged into this are to import its contents
The following lists properties for file artifacts:
- Filename: The file name of the stored file artifact
- OS Family: The Operating System family is supported by the file
- Description: A description for the file artifact
Artifact Arguments (Script Artifacts Only)
The Arguments tab allows artifact owners and administrators to specify the expected scripts argument names and the argument input mode
Select the argument input mode from the following supported options:
- Free-form arguments - the script is written to handle any number of variables passed in without specific positional meaning
- Position arguments - the script accepts variables in defined positions
- Named arguments - the script accepts variables without positional meaning but requires that the variables are assigned by name
- No arguments - the script does not expect any variables to be passed in
The Metadata tabs allows artifact owners and administrators to view the artifact's metadata.
It also allows the artifact owner to be modified. Click on the Edit button to select a new owner.
Permissions allow for artifact owners and administrators to control access to the artifact. By default, no additional users are granted permissions to an artifact and only the artifact owner will have permissions.
Click Add if other users/groups require access.
Click each of the Permissions (Consume/Manage) to toggle whether the listed user/group is allowed/denied the selected action.