diff options
author | Valerij Fredriksen <valerijf@yahooinc.com> | 2022-05-03 16:06:14 +0200 |
---|---|---|
committer | Valerij Fredriksen <valerijf@yahooinc.com> | 2022-05-05 14:55:53 +0200 |
commit | 9624701b8f3fa93779aa6fb352aacebb6dd138ac (patch) | |
tree | c2f490284b52d9f76b8cc608714ee0ab752fae9a | |
parent | 25e3c3a9ac64309593433e87ade9d608c4c2c2e4 (diff) |
Generalize ContainerImageExpirer to ArtifactExpirer
11 files changed, 87 insertions, 80 deletions
diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/ServiceRegistry.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/ServiceRegistry.java index be32b74591b..c258f088eeb 100644 --- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/ServiceRegistry.java +++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/ServiceRegistry.java @@ -4,6 +4,7 @@ package com.yahoo.vespa.hosted.controller.api.integration; import com.yahoo.config.provision.HostName; import com.yahoo.vespa.hosted.controller.api.identifiers.ControllerVersion; import com.yahoo.vespa.hosted.controller.api.integration.archive.ArchiveService; +import com.yahoo.vespa.hosted.controller.api.integration.artifact.ArtifactRegistry; import com.yahoo.vespa.hosted.controller.api.integration.athenz.AccessControlService; import com.yahoo.vespa.hosted.controller.api.integration.aws.CloudEventFetcher; import com.yahoo.vespa.hosted.controller.api.integration.aws.ResourceTagger; @@ -14,7 +15,6 @@ import com.yahoo.vespa.hosted.controller.api.integration.billing.PlanRegistry; import com.yahoo.vespa.hosted.controller.api.integration.certificates.EndpointCertificateProvider; import com.yahoo.vespa.hosted.controller.api.integration.certificates.EndpointCertificateValidator; import com.yahoo.vespa.hosted.controller.api.integration.configserver.ConfigServer; -import com.yahoo.vespa.hosted.controller.api.integration.container.ContainerRegistry; import com.yahoo.vespa.hosted.controller.api.integration.deployment.ApplicationStore; import com.yahoo.vespa.hosted.controller.api.integration.deployment.ArtifactRepository; import com.yahoo.vespa.hosted.controller.api.integration.deployment.TesterCloud; @@ -99,7 +99,7 @@ public interface ServiceRegistry { BillingDatabaseClient billingDatabase(); - ContainerRegistry containerRegistry(); + ArtifactRegistry containerRegistry(); TenantSecretService tenantSecretService(); diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/ContainerImage.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/Artifact.java index 9652eeef530..94997b7dbba 100644 --- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/ContainerImage.java +++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/Artifact.java @@ -1,5 +1,5 @@ // Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -package com.yahoo.vespa.hosted.controller.api.integration.container; +package com.yahoo.vespa.hosted.controller.api.integration.artifact; import com.yahoo.component.Version; @@ -8,23 +8,31 @@ import java.util.Objects; import java.util.Optional; /** - * A container image. + * A registry artifact (e.g. container image or RPM) * * @author mpolden */ -public class ContainerImage { +public class Artifact { private final String id; - private final String registry; - private final String repository; + private final Optional<String> registry; + private final Optional<String> repository; private final Instant createdAt; private final Version version; private final Optional<Architecture> architecture; - public ContainerImage(String id, String registry, String repository, Instant createdAt, Version version, Optional<Architecture> architecture) { + public Artifact(String id, String registry, String repository, Instant createdAt, Version version, Optional<Architecture> architecture) { this.id = Objects.requireNonNull(id); - this.registry = Objects.requireNonNull(registry); - this.repository = Objects.requireNonNull(repository); + this.registry = Optional.of(registry); + this.repository = Optional.of(repository); + this.createdAt = Objects.requireNonNull(createdAt); + this.version = Objects.requireNonNull(version); + } + + public Artifact(String id, Instant createdAt, Version version) { + this.id = Objects.requireNonNull(id); + this.registry = Optional.empty(); + this.repository = Optional.empty(); this.createdAt = Objects.requireNonNull(createdAt); this.version = Objects.requireNonNull(version); this.architecture = Objects.requireNonNull(architecture); @@ -35,13 +43,13 @@ public class ContainerImage { return id; } - /** The registry holding this image */ - public String registry() { + /** The registry holding this artifact */ + public Optional<String> registry() { return registry; } - /** Repository of this image */ - public String repository() { + /** Repository of this artifact */ + public Optional<String> repository() { return repository; } @@ -69,7 +77,7 @@ public class ContainerImage { public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; - ContainerImage that = (ContainerImage) o; + Artifact that = (Artifact) o; return id.equals(that.id) && registry.equals(that.registry) && repository.equals(that.repository) && @@ -85,8 +93,8 @@ public class ContainerImage { @Override public String toString() { - return "container image " + repository + " [registry=" + registry + ",version=" + version.toFullString() + - ",createdAt=" + createdAt + ",architecture=" + architecture.map(Enum::name).orElse("<none>") + "]"; + String name = repository.isPresent() ? registry.get() + "/" + repository.get() : id; + return "artifact " + name + " [version=" + version.toFullString() + ",createdAt=" + createdAt + ",architecture=" + architecture.map(Enum::name).orElse("<none>") + "]"; } public enum Architecture { diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/ArtifactRegistry.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/ArtifactRegistry.java new file mode 100644 index 00000000000..8d3c19083c9 --- /dev/null +++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/ArtifactRegistry.java @@ -0,0 +1,20 @@ +// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.vespa.hosted.controller.api.integration.artifact; + + +import java.util.List; + +/** + * A registry of artifacts (e.g. container image or RPM). + * + * @author mpolden + */ +public interface ArtifactRegistry { + + /** Delete all given artifacts */ + void deleteAll(List<Artifact> images); + + /** Returns a list of all artifacts in this system */ + List<Artifact> list(); + +} diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/package-info.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/package-info.java index ca1f6afc5db..8e12be06583 100644 --- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/package-info.java +++ b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/artifact/package-info.java @@ -3,6 +3,6 @@ * @author mpolden */ @ExportPackage -package com.yahoo.vespa.hosted.controller.api.integration.container; +package com.yahoo.vespa.hosted.controller.api.integration.artifact; import com.yahoo.osgi.annotation.ExportPackage; diff --git a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/ContainerRegistry.java b/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/ContainerRegistry.java deleted file mode 100644 index 78757ad995a..00000000000 --- a/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/container/ContainerRegistry.java +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -package com.yahoo.vespa.hosted.controller.api.integration.container; - - -import java.util.List; - -/** - * A registry of container images. - * - * @author mpolden - */ -public interface ContainerRegistry { - - /** Delete all given images */ - void deleteAll(List<ContainerImage> images); - - /** Returns a list of all container images in this system */ - List<ContainerImage> list(); - -} diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ContainerImageExpirer.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ArtifactExpirer.java index c87dd262fa3..a7cff2fdda0 100644 --- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ContainerImageExpirer.java +++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ArtifactExpirer.java @@ -4,7 +4,7 @@ package com.yahoo.vespa.hosted.controller.maintenance; import com.yahoo.component.Version; import com.yahoo.config.provision.SystemName; import com.yahoo.vespa.hosted.controller.Controller; -import com.yahoo.vespa.hosted.controller.api.integration.container.ContainerImage; +import com.yahoo.vespa.hosted.controller.api.integration.artifact.Artifact; import com.yahoo.vespa.hosted.controller.versions.VersionStatus; import com.yahoo.vespa.hosted.controller.versions.VespaVersion; @@ -19,17 +19,17 @@ import java.util.logging.Logger; import java.util.stream.Collectors; /** - * Periodically expire unused container images. + * Periodically expire unused artifacts, e.g. container images and RPMs. * * @author mpolden */ -public class ContainerImageExpirer extends ControllerMaintainer { +public class ArtifactExpirer extends ControllerMaintainer { - private static final Logger log = Logger.getLogger(ContainerImageExpirer.class.getName()); + private static final Logger log = Logger.getLogger(ArtifactExpirer.class.getName()); private static final Duration MIN_AGE = Duration.ofDays(14); - public ContainerImageExpirer(Controller controller, Duration interval) { + public ArtifactExpirer(Controller controller, Duration interval) { super(controller, interval, null, expiringSystems()); } @@ -37,31 +37,31 @@ public class ContainerImageExpirer extends ControllerMaintainer { protected double maintain() { Instant now = controller().clock().instant(); VersionStatus versionStatus = controller().readVersionStatus(); - List<ContainerImage> imagesToExpire = controller().serviceRegistry().containerRegistry().list().stream() - .filter(image -> isExpired(image, now, versionStatus)) + List<Artifact> artifactsToExpire = controller().serviceRegistry().containerRegistry().list().stream() + .filter(artifact -> isExpired(artifact, now, versionStatus)) .collect(Collectors.toList()); - if (!imagesToExpire.isEmpty()) { - log.log(Level.INFO, "Expiring " + imagesToExpire.size() + " container images: " + imagesToExpire); - controller().serviceRegistry().containerRegistry().deleteAll(imagesToExpire); + if (!artifactsToExpire.isEmpty()) { + log.log(Level.INFO, "Expiring " + artifactsToExpire.size() + " artifacts: " + artifactsToExpire); + controller().serviceRegistry().containerRegistry().deleteAll(artifactsToExpire); } return 1.0; } - /** Returns whether given image is expired */ - private boolean isExpired(ContainerImage image, Instant now, VersionStatus versionStatus) { + /** Returns whether given artifact is expired */ + private boolean isExpired(Artifact artifact, Instant now, VersionStatus versionStatus) { List<VespaVersion> versions = versionStatus.versions(); if (versions.isEmpty()) return false; - if (versionStatus.isActive(image.version())) return false; - if (image.createdAt().isAfter(now.minus(MIN_AGE))) return false; + if (versionStatus.isActive(artifact.version())) return false; + if (artifact.createdAt().isAfter(now.minus(MIN_AGE))) return false; Version maxVersion = versions.stream().map(VespaVersion::versionNumber).max(Comparator.naturalOrder()).get(); - if (image.version().isAfter(maxVersion)) return false; // A future version + if (artifact.version().isAfter(maxVersion)) return false; // A future version return true; } - /** Returns systems where images can be expired */ + /** Returns systems where artifacts can be expired */ private static Set<SystemName> expiringSystems() { // Run only in public and main. Public systems have distinct container registries, while main and CD have // shared registries. diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ControllerMaintenance.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ControllerMaintenance.java index 041d0694ca9..e929940b68b 100644 --- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ControllerMaintenance.java +++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/maintenance/ControllerMaintenance.java @@ -63,7 +63,7 @@ public class ControllerMaintenance extends AbstractComponent { maintainers.add(new ResourceTagMaintainer(controller, intervals.resourceTagMaintainer, controller.serviceRegistry().resourceTagger())); maintainers.add(new SystemRoutingPolicyMaintainer(controller, intervals.systemRoutingPolicyMaintainer)); maintainers.add(new ApplicationMetaDataGarbageCollector(controller, intervals.applicationMetaDataGarbageCollector)); - maintainers.add(new ContainerImageExpirer(controller, intervals.containerImageExpirer)); + maintainers.add(new ArtifactExpirer(controller, intervals.containerImageExpirer)); maintainers.add(new HostInfoUpdater(controller, intervals.hostInfoUpdater)); maintainers.add(new ReindexingTriggerer(controller, intervals.reindexingTriggerer)); maintainers.add(new EndpointCertificateMaintainer(controller, intervals.endpointCertificateMaintainer)); diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ContainerRegistryMock.java b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ArtifactRegistryMock.java index 4791017548d..1d3974fe7a7 100644 --- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ContainerRegistryMock.java +++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ArtifactRegistryMock.java @@ -1,8 +1,8 @@ // Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. package com.yahoo.vespa.hosted.controller.integration; -import com.yahoo.vespa.hosted.controller.api.integration.container.ContainerImage; -import com.yahoo.vespa.hosted.controller.api.integration.container.ContainerRegistry; +import com.yahoo.vespa.hosted.controller.api.integration.artifact.Artifact; +import com.yahoo.vespa.hosted.controller.api.integration.artifact.ArtifactRegistry; import java.util.Comparator; import java.util.HashMap; @@ -13,26 +13,26 @@ import java.util.stream.Collectors; /** * @author mpolden */ -public class ContainerRegistryMock implements ContainerRegistry { +public class ArtifactRegistryMock implements ArtifactRegistry { - private static final Comparator<ContainerImage> comparator = Comparator.comparing(ContainerImage::registry) - .thenComparing(ContainerImage::repository) - .thenComparing(ContainerImage::version); + private static final Comparator<Artifact> comparator = Comparator.comparing((Artifact artifact) -> artifact.registry().orElse("")) + .thenComparing(artifact -> artifact.repository().orElse("")) + .thenComparing(Artifact::version); - private final Map<String, ContainerImage> images = new HashMap<>(); + private final Map<String, Artifact> images = new HashMap<>(); - public ContainerRegistryMock add(ContainerImage image) { + public ArtifactRegistryMock add(Artifact image) { images.put(image.id(), image); return this; } @Override - public void deleteAll(List<ContainerImage> images) { + public void deleteAll(List<Artifact> images) { images.forEach(image -> this.images.remove(image.id())); } @Override - public List<ContainerImage> list() { + public List<Artifact> list() { return images.values().stream().sorted(comparator).collect(Collectors.toUnmodifiableList()); } diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java index 0afb1e67a85..0b37c4ebb8d 100644 --- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java +++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/integration/ServiceRegistryMock.java @@ -82,7 +82,7 @@ public class ServiceRegistryMock extends AbstractComponent implements ServiceReg private final MockResourceTagger mockResourceTagger = new MockResourceTagger(); private final RoleService roleService = new MockRoleService(); private final BillingController billingController = new MockBillingController(clock); - private final ContainerRegistryMock containerRegistry = new ContainerRegistryMock(); + private final ArtifactRegistryMock containerRegistry = new ArtifactRegistryMock(); private final NoopTenantSecretService tenantSecretService = new NoopTenantSecretService(); private final ArchiveService archiveService = new MockArchiveService(); private final MockChangeRequestClient changeRequestClient = new MockChangeRequestClient(); @@ -236,7 +236,7 @@ public class ServiceRegistryMock extends AbstractComponent implements ServiceReg } @Override - public ContainerRegistryMock containerRegistry() { + public ArtifactRegistryMock containerRegistry() { return containerRegistry; } diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/ContainerImageExpirerTest.java b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/ArtifactExpirerTest.java index baebf7239ee..ddc1c0b599f 100644 --- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/ContainerImageExpirerTest.java +++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/maintenance/ArtifactExpirerTest.java @@ -2,10 +2,10 @@ package com.yahoo.vespa.hosted.controller.maintenance; import com.yahoo.component.Version; -import com.yahoo.vespa.hosted.controller.api.integration.container.ContainerImage; +import com.yahoo.vespa.hosted.controller.api.integration.artifact.Artifact; import com.yahoo.vespa.hosted.controller.api.integration.container.ContainerImage.Architecture; import com.yahoo.vespa.hosted.controller.deployment.DeploymentTester; -import com.yahoo.vespa.hosted.controller.integration.ContainerRegistryMock; +import com.yahoo.vespa.hosted.controller.integration.ArtifactRegistryMock; import org.junit.Test; import java.time.Duration; @@ -18,19 +18,18 @@ import static org.junit.Assert.assertEquals; /** * @author mpolden */ -public class ContainerImageExpirerTest { +public class ArtifactExpirerTest { @Test public void maintain() { DeploymentTester tester = new DeploymentTester(); - ContainerImageExpirer expirer = new ContainerImageExpirer(tester.controller(), Duration.ofDays(1)); - ContainerRegistryMock registry = tester.controllerTester().serviceRegistry().containerRegistry(); + ArtifactExpirer expirer = new ArtifactExpirer(tester.controller(), Duration.ofDays(1)); + ArtifactRegistryMock registry = tester.controllerTester().serviceRegistry().containerRegistry(); Instant instant = tester.clock().instant(); - ContainerImage image0 = new ContainerImage("image0", "registry.example.com", "vespa/vespa", instant, Version.fromString("7.1"), Optional.empty()); - ContainerImage image1 = new ContainerImage("image1", "registry.example.com", "vespa/vespa", instant, Version.fromString("7.2"), Optional.of(Architecture.amd64)); - ContainerImage image2 = new ContainerImage("image2", "registry.example.com", "vespa/vespa", instant, Version.fromString("7.4"), Optional.of(Architecture.amd64)); - + Artifact image0 = new Artifact("image0", "registry.example.com", "vespa/vespa", instant, Version.fromString("7.1"), Optional.empty()); + Artifact image1 = new Artifact("image1", "registry.example.com", "vespa/vespa", instant, Version.fromString("7.2"), Optional.of(Architecture.amd64)); + Artifact image2 = new Artifact("image2", "registry.example.com", "vespa/vespa", instant, Version.fromString("7.4"), Optional.of(Architecture.amd64)); registry.add(image0) .add(image1) .add(image2); @@ -53,7 +52,7 @@ public class ContainerImageExpirerTest { assertEquals(List.of(image1, image2), registry.list()); // A new version becomes active. The active and future version are kept - ContainerImage image3 = new ContainerImage("image3", "registry.example.com", "vespa/vespa", tester.clock().instant(), Version.fromString("7.3"), Optional.of(Architecture.amd64)); + Artifact image3 = new Artifact("image3", "registry.example.com", "vespa/vespa", tester.clock().instant(), Version.fromString("7.3"), Optional.of(Architecture.amd64)); registry.add(image3); tester.controllerTester().upgradeSystem(image3.version()); expirer.maintain(); diff --git a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/controller/responses/maintenance.json b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/controller/responses/maintenance.json index 79e11fa1140..8b2e5578ae0 100644 --- a/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/controller/responses/maintenance.json +++ b/controller-server/src/test/java/com/yahoo/vespa/hosted/controller/restapi/controller/responses/maintenance.json @@ -13,6 +13,9 @@ "name": "ArchiveUriUpdater" }, { + "name": "ArtifactExpirer" + }, + { "name": "BillingDatabaseMaintainer" }, { @@ -28,9 +31,6 @@ "name": "ContactInformationMaintainer" }, { - "name": "ContainerImageExpirer" - }, - { "name": "CostReportMaintainer" }, { |