Upload the Access YAML File

Use access.config.patch.yml for partial updates or access.config.import.yml for a full replace of the JFrog Access configuration.

To change some Access settings, create access.config.patch.yml. To replace the entire Access configuration, create access.config.import.yml.

Starting with JFrog Artifactory 7.146.0, Access no longer creates access.config.latest.yml. If you use an earlier version, see Artifactory 7.133.x and earlier.

JFrog Access uses three configuration files in $JFROG_HOME/artifactory/var/etc/access/:

FilePurpose
access.config.template.ymlRead-only reference listing all available configuration keys and their default values.
access.config.patch.ymlThe file you create for a partial update. The Access service merges the values in it into the current configuration on restart and leaves all other settings unchanged.
access.config.import.ymlThe file you create for a full replacement. The Access service reads it on restart and replaces the entire configuration with its contents.

Example

To change number-of-retries from 3 to 5 and leave all other settings unchanged:

  1. Open access.config.template.yml and locate the key to modify (e.g. number-of-retries: 3).
  2. Create a new file named access.config.patch.yml in $JFROG_HOME/artifactory/var/etc/access/ and paste the key-value pair from the template file, including its parent keys.
  3. Update the value in access.config.patch.yml (e.g. change number-of-retries to 5).
  4. Restart Artifactory to apply the changes. Restarting Artifactory also restarts the Access service, which loads access.config.patch.yml and merges the change into the current configuration.

Replace the entire configuration

Use access.config.import.yml only when you want to replace the whole Access configuration. The import file is a full replace: it overrides all existing settings, so include every setting you want to keep.

Access stores your current configuration in the Access database, not in a file.

Artifactory 7.133.x and earlier

In Artifactory 7.133.x and earlier, Access also maintains access.config.latest.yml in the same directory. It holds the current running configuration. To apply a change in these versions:

  1. Open access.config.template.yml and locate the key to modify (e.g. number-of-retries: 3).
  2. Open access.config.latest.yml and paste the key-value pair from the template file.
  3. Update the value in access.config.latest.yml (e.g. change number-of-retries to 5).
  4. Save access.config.latest.yml as access.config.import.yml in $JFROG_HOME/artifactory/var/etc/access/.
  5. Restart Artifactory to apply the changes.

Related Topics


Did this page help you?