|
| 1 | +/* |
| 2 | + * Copyright 2016 Red Hat, Inc. |
| 3 | + * |
| 4 | + * Red Hat licenses this file to you under the Apache License, version |
| 5 | + * 2.0 (the "License"); you may not use this file except in compliance |
| 6 | + * with the License. You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
| 13 | + * implied. See the License for the specific language governing |
| 14 | + * permissions and limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package io.fabric8.maven.enricher.standard; |
| 18 | + |
| 19 | +import com.fasterxml.jackson.core.JsonProcessingException; |
| 20 | +import io.fabric8.kubernetes.api.builder.TypedVisitor; |
| 21 | +import io.fabric8.kubernetes.api.builder.Visitable; |
| 22 | +import io.fabric8.kubernetes.api.builder.VisitableBuilder; |
| 23 | +import io.fabric8.kubernetes.api.model.Container; |
| 24 | +import io.fabric8.kubernetes.api.model.ContainerBuilder; |
| 25 | +import io.fabric8.kubernetes.api.model.HasMetadata; |
| 26 | +import io.fabric8.kubernetes.api.model.KubernetesListBuilder; |
| 27 | +import io.fabric8.kubernetes.api.model.ObjectMeta; |
| 28 | +import io.fabric8.kubernetes.api.model.ObjectMetaBuilder; |
| 29 | +import io.fabric8.kubernetes.api.model.extensions.DaemonSet; |
| 30 | +import io.fabric8.kubernetes.api.model.extensions.DaemonSetBuilder; |
| 31 | +import io.fabric8.kubernetes.api.model.extensions.ReplicaSet; |
| 32 | +import io.fabric8.kubernetes.api.model.extensions.ReplicaSetBuilder; |
| 33 | +import io.fabric8.kubernetes.api.model.extensions.StatefulSet; |
| 34 | +import io.fabric8.kubernetes.api.model.extensions.StatefulSetBuilder; |
| 35 | +import io.fabric8.maven.core.util.Configs; |
| 36 | +import io.fabric8.maven.core.util.JSONUtil; |
| 37 | +import io.fabric8.maven.docker.util.ImageName; |
| 38 | +import io.fabric8.maven.enricher.api.BaseEnricher; |
| 39 | +import io.fabric8.maven.enricher.api.EnricherContext; |
| 40 | +import io.fabric8.openshift.api.model.ImageChangeTrigger; |
| 41 | +import io.fabric8.openshift.api.model.ImageChangeTriggerBuilder; |
| 42 | + |
| 43 | +import java.util.*; |
| 44 | + |
| 45 | +/** |
| 46 | + * This adds a `image.openshift.io/triggers` tag to all kubernetes resources in order to make them run on Openshift when using ImageStreams. |
| 47 | + * |
| 48 | + * @author nicola |
| 49 | + * @since 10/05/18 |
| 50 | + */ |
| 51 | +public class TriggersAnnotationEnricher extends BaseEnricher { |
| 52 | + |
| 53 | + private static final String TRIGGERS_ANNOTATION = "image.openshift.io/triggers"; |
| 54 | + |
| 55 | + // Available configuration keys |
| 56 | + private enum Config implements Configs.Key { |
| 57 | + |
| 58 | + /** |
| 59 | + * Comma-separated list of container names that should be enriched (default all that apply) |
| 60 | + */ |
| 61 | + containers; |
| 62 | + |
| 63 | + protected String d; public String def() { |
| 64 | + return d; |
| 65 | + } |
| 66 | + } |
| 67 | + |
| 68 | + |
| 69 | + public TriggersAnnotationEnricher(EnricherContext buildContext) { |
| 70 | + super(buildContext, "fmp-triggers-annotation"); |
| 71 | + } |
| 72 | + |
| 73 | + @Override |
| 74 | + public void adapt(KubernetesListBuilder builder) { |
| 75 | + |
| 76 | + builder.accept(new TypedVisitor<StatefulSetBuilder>() { |
| 77 | + @Override |
| 78 | + public void visit(StatefulSetBuilder o) { |
| 79 | + StatefulSet s = o.build(); |
| 80 | + if (canWriteTriggers(s)) { |
| 81 | + o.withMetadata(getMetaEnrichedWithTriggers(s.getMetadata(), o)); |
| 82 | + } |
| 83 | + } |
| 84 | + }); |
| 85 | + |
| 86 | + builder.accept(new TypedVisitor<ReplicaSetBuilder>() { |
| 87 | + @Override |
| 88 | + public void visit(ReplicaSetBuilder o) { |
| 89 | + ReplicaSet s = o.build(); |
| 90 | + if (canWriteTriggers(s)) { |
| 91 | + o.withMetadata(getMetaEnrichedWithTriggers(s.getMetadata(), o)); |
| 92 | + } |
| 93 | + } |
| 94 | + }); |
| 95 | + |
| 96 | + builder.accept(new TypedVisitor<DaemonSetBuilder>() { |
| 97 | + @Override |
| 98 | + public void visit(DaemonSetBuilder o) { |
| 99 | + DaemonSet s = o.build(); |
| 100 | + if (canWriteTriggers(s)) { |
| 101 | + o.withMetadata(getMetaEnrichedWithTriggers(s.getMetadata(), o)); |
| 102 | + } |
| 103 | + } |
| 104 | + }); |
| 105 | + |
| 106 | + } |
| 107 | + |
| 108 | + protected ObjectMeta getMetaEnrichedWithTriggers(ObjectMeta meta, VisitableBuilder<?, ?> o) { |
| 109 | + ObjectMetaBuilder metaBuilder; |
| 110 | + if (meta != null) { |
| 111 | + metaBuilder = new ObjectMetaBuilder(meta); |
| 112 | + } else { |
| 113 | + metaBuilder = new ObjectMetaBuilder(); |
| 114 | + } |
| 115 | + |
| 116 | + return metaBuilder |
| 117 | + .addToAnnotations(TRIGGERS_ANNOTATION, createAnnotation(o)) |
| 118 | + .build(); |
| 119 | + } |
| 120 | + |
| 121 | + protected boolean canWriteTriggers(HasMetadata res) { |
| 122 | + return res.getMetadata() == null || |
| 123 | + res.getMetadata().getAnnotations() == null || |
| 124 | + !res.getMetadata().getAnnotations().containsKey(TRIGGERS_ANNOTATION); |
| 125 | + } |
| 126 | + |
| 127 | + protected String createAnnotation(Visitable<?> builder) { |
| 128 | + final List<ImageChangeTrigger> triggerList = new ArrayList<>(); |
| 129 | + builder.accept(new TypedVisitor<ContainerBuilder>() { |
| 130 | + @Override |
| 131 | + public void visit(ContainerBuilder cb) { |
| 132 | + Container container = cb.build(); |
| 133 | + String containerName = container.getName(); |
| 134 | + String containerImage = container.getImage(); |
| 135 | + ImageName image = new ImageName(containerImage); |
| 136 | + if (isContainerAllowed(containerName) && image.getRegistry() == null && image.getUser() == null) { |
| 137 | + // Imagestreams used as trigger are in the same namespace |
| 138 | + String tag = image.getTag() != null ? image.getTag() : "latest"; |
| 139 | + |
| 140 | + ImageChangeTrigger trigger = new ImageChangeTriggerBuilder() |
| 141 | + .withNewFrom() |
| 142 | + .withKind("ImageStreamTag") |
| 143 | + .withName(image.getSimpleName() + ":" + tag) |
| 144 | + .endFrom() |
| 145 | + .build(); |
| 146 | + |
| 147 | + trigger.setAdditionalProperty("fieldPath", "spec.template.spec.containers[?(@.name==\"" + containerName + "\")].image"); |
| 148 | + triggerList.add(trigger); |
| 149 | + } |
| 150 | + } |
| 151 | + }); |
| 152 | + |
| 153 | + try { |
| 154 | + return JSONUtil.mapper().writeValueAsString(triggerList); |
| 155 | + } catch (JsonProcessingException e) { |
| 156 | + getLog().error("Error while creating ImageStreamTag triggers for Kubernetes resources: %s", e); |
| 157 | + return "[]"; |
| 158 | + } |
| 159 | + } |
| 160 | + |
| 161 | + protected boolean isContainerAllowed(String containerName) { |
| 162 | + String namesStr = this.getConfig(Config.containers); |
| 163 | + Set<String> allowedNames = new HashSet<>(); |
| 164 | + if (namesStr != null) { |
| 165 | + for (String name : namesStr.split(",")) { |
| 166 | + allowedNames.add(name.trim()); |
| 167 | + } |
| 168 | + } |
| 169 | + |
| 170 | + return allowedNames.isEmpty() || allowedNames.contains(containerName); |
| 171 | + } |
| 172 | + |
| 173 | +} |
0 commit comments