Image and artifact management with Artifactory
Artifactory is an artifact repository system by JFrog. This service is available to B.C. government development teams who build cloud-native applications on the OpenShift platform.
For more information on Artifactory from JFrog, see the Artifactory documentation.
On this page
- Remote (caching/proxy) repository access
- Local private repositories
- Xray artifact scanning
- Security reviews
- Artifactory support, processes, and communications
- Service improvements and disruptions
- Set up Artifactory
Use Artifactory to access artifacts for your application. It's compatible with all major package types, including Docker images, Helm charts, NPM packages and more. For more information on package management, see Package Management.
The Platform Services team uses Artifactory to provide the following services:
Remote repositories serve as caches/proxies for all major public artifact repositories/registries and several private repositories/registries where BC Government owns licensed access. These repositories cache artifacts that are pulled through them, reducing build time and network traffic. The list of remote repositories include DockerHub, NPM, PyPi, RedHat's private image registry and more.
Artifactory Projects are spaces of quota-limited storage where teams have full control. This lets teams create their own private repositories in Artifactory where they can push and pull their own artifacts of any type. It also allows teams to control access to these repositories, similar to the way teams control access to their own OpenShift namespaces. For more information on requesting an Artifactory Project, see Setup an Artifactory project and repository.
Xray is an add-on service to Artifactory that provides security scanning for all objects in Artifactory. This includes any objects that have been cached in Artifactory through the remote repositories and all artifacts pushed to any private repositories created by individual teams. Teams are able to create and review security reports on artifacts in their private repositories.
We deployed Artifactory in a highly available configuration in the B.C. government OpenShift cluster. The service is available 24/7 with best effort to restart failed systems. Private repository requests are reviewed and handled during normal business hours.
There is no charge to use Artifactory.
Remote (caching/proxy) repository access
Access to remote (caching) repositories is available by default to anyone in the Silver or Gold clusters. When a project set is provisioned, an Artifactory service account is created at the same time, with a secret in the tools namespace available to use.
Find available repositories
Use your service account and username to run the following curl command to get an updated list of caching repositories available from Artifactory:
curl -u username:password -X GET "https://artifacts.developer.gov.bc.ca/artifactory/api/repositories?type=remote" | \ jq -r '(["ARTIFACTORYKEY","SOURCEURL"] | (., map(length*"-"))), (. | [.key, .url]) | @tsv' | column -t
If there is a specific public repository you want to see cached through Artifactory, reach out to the Platform Services team to ask about adding it.
Local private repositories
You can use a local private repository to push your own artifacts and images, with control over access. The benefits include the following:
You'll have a common space to store sensitive artifacts and images.
You can share artifacts with other teams working in OpenShift.
You have flexible control over who and how your team accesses the artifacts.
You can use the same pull secrets you use to access the remote repositories.
You need to set up an Artifactory project before you can get a local private repository. For more information, see Setup an Artifactory project and repository.
Xray artifact scanning
The Xray tool scans all artifacts for security issues and lets you know about potential issues. This gives you an opportunity to deal with issues before they become a problem. The benefits include the following:
Getting images scanned is easy. You only need a private repository in Artifactory.
Our amazing resident security expert can easily have access to the scan reports for your artifacts if you need help with them.
You can ensure all of your images - especially your production images - are secure without placing additional load on your developers.
Privacy Impact Assessment (PIA) and Security Threat Risk Assessment (STRA) have been completed for Sysdig Monitor. These assessments are available by request only, the request can be sent to PlatformServicesTeam@gov.bc.ca.
Artifactory support, processes, and communications
The team supporting this service administers the Artifactory application, its supporting database and the S3 storage system that contains the packages uploaded to Artifactory.
Your best source for support, configuration and best practices is the developer community that uses Artifactory for their projects. Check out the
#devops-artifactory channel on Rocket.Chat. Service changes are also posted here.
For further support in the event of an emergency or outage, contact one of the Artifactory administrators on the
#devops-sos channel on Rocket.Chat.
For cluster-wide service notifications that could impact Artifactory, monitor the
#devops-alerts channel in Rocket.Chat.
Service improvements and disruptions
Artifactory service improvements include software upgrades for both Artifactory and its operator, feature integrations for the operator, bug fixes and more.
These operations don't result in expected disruptions for users. If the Platform Services team expects disruptions, they'll notify everyone about of upcoming changes in
#devops-artifactory, but it may be with limited notice.
Other operations require turning Artifactory to read-only mode. In read-only mode you'll still be able to pull from Artifactory, but not push. If the team expects a disruption, they'll notify everyone about the planned read-only window at least a day before in the
Set up Artifactory
To get started using Artifactory, see Setup an Artifactory service account.
- JFROG documentation
- Privacy Impact Assessment (PIA)
- Security Threat Risk Assessment (STRA)
- Setup an Artifactory service account
- Setup an Artifactory project and repository