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

Overview

The Manage module is where you can configure many aspects of the Artifactory instances under your control using the following sub-modules:

InstancesApply various configurations such as defining proxies, property sets, LDAP settings and more.
RepositoriesCreate and update repositories.
SecurityManage users, groups and permissions.
LicensesManage licenses

You can configure Artifactory instances by creating configuration scripts, and then applying them in the Apply Scripts phase of the Manage | Update Instance wizard.

Configuring Multiple Instances with Multiple Scripts

Mission control lets you apply any number of configuration scripts to any number of instances in a single action. You can either select instances individually, or define several instances as a logical group which you can then select as the collective target for configuration actions defined in the scripts.

This presents benefits such as enabling automation, reuse of configuration scripts and standardization of all Artifactory instances you are managing. For more details, please refer to Benefits of Using Configuration Scripts.

Instances

In order to configure Artifactory instances under your control, you first need to add those instances to Mission Control.

Using Instance scripts, you can configure the following aspects of Artifactory:

Adding a New Instance

You can add a new instance that should be managed by Mission Control by clicking "Add Instance" in the Instance BrowserFor details, please refer to the Adding an Artifactory Instance tutorial.

Page Contents

Updating Instances

To update Artifactory instances under your control, in the Manage module select Instances | Update instance.

There are four stages to this process:

Selecting Target Instances

Selecting target instances

The first stage of the wizard, displays all the instances and instance groups you have defined in Mission Control.

Select the instances and groups you want to update and click Continue to select configuration scripts to apply.

Groups

By defining and selecting groups, you can apply all selected configuration scripts to each member of the group simultaneously.

Applying Configuration Scripts

The second stage of the wizard is Apply Scripts. In this stage you will define which configuration scripts should be applied to the different instances you selected in the previous stage.

Under Select Scripts select the configuration scripts you want to apply, and under  Apply To, select any subset of the target instances you selected in the previous step.

Then, click "Submit".

Selecting scripts and instances

After clicking "Submit" you will see all the configuration scripts that will be applied to each selected group or instance.

You may repeat this process until you have selected all the script combinations that you want to apply to all of the selected instances. When you are done, click "Continue".

Different roles per instance

 You don't have to apply the same configuration scripts to all the selected instances. You can select different script and instance combinations to apply any set of scripts to any set of instances.

If you are applying multiple scripts, you can click Edit Order in order to change the order in which scripts are applied with a simple drag and drop operation.

Reordering scripts

User Input

To give you the flexibility to provide configuration parameters when configuration scripts are executed, scripts can be written to require user input. If any of the scripts you have applied to the selected instances require user input, will now be prompted to enter it. Note that you need to provide the fields requested separately for each group and instance you are updating, however, default values may have been provided.

Adding user input

Once you have provided all the required user input, click "Continue".

Running the Update

Update instance summary

The Summary screen displays the configuration scripts that you may now apply to each of the selected groups or instances.

To start applying the scripts, click "Execute All".

Mission Control will apply the scripts to the instances and display success or error notifications accordingly. You may also view the results of each script application by clicking the information icon next to the corresponding instance.

Summary

Click "Retry" to retry applying any scripts that failed, or "Rollback" to undo any script applications that succeeded.



Repositories

Once you have added an Artifactory instance to Mission Control, you have full access to all repositories in that instance. With Mission Control, you can both create new repositories and update existing ones for all Artifactory instances under your control.

Using Repository configuration scripts, Mission Control lets you create local, remote or virtual repositories, create replications between them and update any of their parameters.

Creating a New Repository

To create a new repository, in the Manage module, select Repositories | New repository.

There are four stages to this process:

Selecting Target Instances

Creating a new repository

Select the Artifactory instances on which you want to create the new repository, and click Continue

Instance Groups

You can select individual Artifactory instances or instance groups to create the repository in all members of the instance group in a single action.

Applying Configuration Scripts

For each instance you selected, select the configuration scripts you want to apply and click Add. Repeat this until all the instances are set with the appropriate scripts.

Create one repository, update multiple

Note that each configuration script may only create a single repository, but it may also update multiple additional repositories.


Selecting scripts

Different scripts per instance

You don't have to apply the same configuration scripts to all the selected instances. You can select different script and instance combinations to apply any set of scripts to any set of instances.

You can see which configuration scripts are set to be applied to which instances under the Applied Scripts section.

Applied scripts


In the Applied Scripts section, you can remove configuration scripts from instances or modify the order in which scripts will be applied by clicking Edit Order.

Once you have configured all the applied scripts you need, click "Continue" to move on to the next step.

User Input

If any of the configuration scripts you selected require user input, you will be prompted for it in the next screen.

User input

Once you have entered all the user input required, click "Continue" to move on to the next step.

Running the Update

Finally, on the Summary screen, click Execute All to execute all the applied scripts on the selected instances and groups.

Summary

If there are any errors in processing the configuration scripts, Mission Control will display an error message. You can view the error status by clicking the information icon for the respective Artifactory instance.

In this case, you will not be able to execute any of the applied scripts, and you need to fix the issue creating the error in order to proceed.

One your configuration scripts can be processed without error and have been run, Mission Control will indicate if the repositories have been created successfully or not. You may roll back any successful operations, or retry those that failed.

If there is an error in execution, you can click the information icon to see why it was not successful.

New repository error

Updating a Repository

The process of updating a repository is nearly identical to creating a new one. The only difference is the additional step of selecting the repositories which you want to update.

Selecting repositories to update


Security

The Mission Control Security sub-module manages users, groups of users and permissions on Artifactory instances under your control. 

Mission Control users vs. Artifactory users

Be careful not to confuse the Security sub-module in the left navigation bar with the Users and Groups tab in the Mission Control configuration.

For more details on managing access to repositories, please refer to Managing Usersand Managing Perimissionsin the Artifactory User Guide.

Managing Users

Creating a New User

To create a new user, in the Manage module, select Security | Create User.

Create user

Select the Artifactory instances on which you want to create the user and click "Continue".

Under Users Info, enter the user's details and click "Add User".

In addition to User Name, Email and Password you need to set the following parameters:

Use password from external authentication

If set, this user will be authenticated by external means (such as LDAP).

Give admin permissions

If set, user will have administrator permissions on the the Artifactory instance.

User can update profile

If set, the user will be able to update their profile.


Repeat this process for all users you want to add. Mission Control will display them all under New Users. At this point you may still delete users from the list.

Click "Continue" to view the summary of the actions you are about to execute. Click "Execute All" to execute the actions.

New users summary

After Mission Control tries to execute the actions, you will see a notification for each action indicating if it succeeded or failed. You can retry actions that failed, or roll back those that succeeded

Creating new users - results

The success/fail notifications will be dismissed automatically within a few seconds, but you can click on the information icon next to an error to view the reason why the action failed.

Creating new users - error messages

Editing Users

The process of editing existing users is very similar to creating new ones. The only difference is that once you have selected the instances to update, you need to search for the user you want to update and select it from the list that Mission Control finds.

Selecting users to update

Managing User Groups

Creating a New User Group

To create a new user group in Artifactory instances, under Manage | Security, select Create Group.


Select the Artifactory instances on which you want to create the group and click "Continue".

Under Group Settings, enter the group name and description.

Check Automatically add new users to this group if you want any new users to be automatically added this group once it is created in the target Artifactory instances.

Under Users select the existing users that should be assigned to this group.

Users displayed

Only users that exist in all Artifactory instances selected will be displayed in this list. If users you were expecting to see are missing from the list, try selecting Artifactory instances individually.

To set the group to be created, click "Add" and repeat the process for any additional groups you want to create.

Under New Groups you can see all the groups you are creating in this flow.

Click Continue to view the summary of actions you are about to execute.

To create the user groups in the selected Artifactory instances, click "Execute All".

After Mission Control tries to execute the actions, you will see a notification for each action indicating if it succeeded or failed. You can retry actions that failed, or roll back those that succeeded.

If there was an error in execution, you can click on the information icon to see the reason.

Editing a User Group

The process of editing an existing user group is very similar to creating a new one. The only difference is that once you have selected the instances to update, you need to search for the user group you want to update and select it from the list that Mission Control finds.

Once you have selected the group, modify its parameters as needed and complete the process in the same way you create a new user group.

Users who are not members of the selected group in all selected instances are indicated by a warning icon.

Managing Permissions

You can use permissions to specify access privileges users or groups of users have to repositories in Artifactory. For more details, please refer to  Managing Permissions in the  Artifactory User Guide.

Creating a New Permission

To create a new Permission in Artifactory instances, under Manage | Security, select New Permission.

Select the Artifactory instances on which you want to create the group and click "Continue".


Select the repositories on which the permission should be applied.

Selecting repositories

Name

A logical name for this permission

Include and Exclude Pattern

Using an "Ant-like" script, you can specify any number of Include or Exclude Patterns as a comma-separated list in the corresponding entry field. 

In the example above, source files have been excluded from the Permission Target named "Not sources" using the appropriate Exclude Pattern.

Available Repositories

The repositories that are available for selection

Selected Repositories

The repositories on which the permission should be applied

Click "Continue".

Under Add Groups, add groups of users to whom the permission should be applied.

Mission Control displays all available groups. Double click a group to select it, and then specify which specific permissions should be granted to the group.

In the above example, Administrators have been given full privileges, while Readers only have Read privileges.

Click "Continue".

In a similar way, under Add Users, you can add individual users to whom the permission should be applied.

In the above example, user eligg has been given full privileges, while anonymous users only have Read privileges.

Click "Continue".

The Summary screen displays the actions you are about to perform.

Click "Execute All" to execute the permission settings on the repositories, user groups and users selected.

Once execution is complete, you can see the results for each selected instance.

In case of an error, click the information icon to view details.

Editing Permissions

The process of editing an existing permission is very similar to creating a new one. The only difference is that once you have selected the instances to update, you need to search for the permission you want to update and select it from the list that Mission Control finds.


Licenses

The Mission Control Licenses sub-module manages activation, renewal and upgrade of all Artifactory instances under your control. You may enter or update the license of several Artifactory instances at a time by matching the instance with its corresponding license, and applying all the licenses in a single bulk operation. To enter or update an Artifactory license, in the Manage module, select Configuration | Update license.

Updating Licenses

The process of applying licenses has four steps:

  1. Selecting instances
  2. Adding licenses
  3. Matching licenses to instances
  4. Applying the licenses

Selecting Instances

Update License - Select Instances

Select the instances and/or groups for which you want to add or update a license.

Group members are displayed individually

If you select a group, then the group's members will later be displayed individually when you need to match them with licenses.

Click "Continue" to move on to the next step.

Adding Licenses

In this stage, you enter the different licenses you want to apply to your Artifactory instances.

Simply paste the licenses you want to add into the Add Licenses entry field and click "Add Licenses".

Adding multiple licenses at once

You can add licenses one at a time, or paste several licenses, separated by an empty line, into the Add Licenses field and add them to the list at once.

Update License - Add Licenses

Click "Continue" to move on to the next step.

Match Licenses to Instances

In this step, you need to match up the Artifactory instances you have selected with the licenses you have added.

First select an Artifactory instance. This will enable the list of licenses.

Then, select the license you wish to apply to the selected instance and click "Add".

The column on the right displays your matched selections.

Update License - Match Licenses

If you which to change how you match Artifactory instances with licenses, you can click Delete to return the instance and licenses of a matched set to their respective lists.

Once you have matched all of your Artifactory instances with their licenses, click "Continue" to move on to the next step.

Artifactory 5 HA Clusters

With clusters running Artifactory 5.0 and above, you attach the license to the cluster as a whole, not to individual nodes. From version 5.0, Artifactory manages allocation of licenses in an HA cluster internally through its Cluster License Manager

Attaching licenses to an Artifactory 5 HA cluster

Apply the Licenses

The Summary screen displays the Artifactory instances that should be updated with the licenses you selected for them.

Update License - Summary

To apply the licenses click "Execute All".

You can retry, but you cannot roll back.

If, for any reason, applying a license does not work in any of the Artifactory instances, you can click the corresponding "Retry" button to try again.

However, once a licenses is applied, you cannot roll back to the previous licenses. 

License Bucket Management

From version 1.2, JFrog Mission Control introduces License Bucket Management which automates, and therefore, greatly simplifies the management of licenses for large numbers of Artifactory instances.

For details, please refer to License Buckets.



  • No labels