add comments

alibaba · Feb 4, 2023 · dee3443 · dee3443
1 parent 565d545
commit dee3443
Show file tree

Hide file tree

Showing 12 changed files with 49 additions and 2 deletions.
diff --git a/...ubernetes-commons/src/main/java/com/alibaba/cloud/kubernetes/commons/KubernetesUtils.java b/...ubernetes-commons/src/main/java/com/alibaba/cloud/kubernetes/commons/KubernetesUtils.java
@@ -22,6 +22,11 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 
 /**
+ * Kubernetes utils.
+ *
+ * <p>
+ * Usually used to get kube config and create {@link KubernetesClient} instance.
+ *
  * @author Freeman
  */
 public final class KubernetesUtils {
@@ -59,7 +64,7 @@ public static String currentNamespace() {
 	}
 
 	/**
-	 * New a KubernetesClient instance.
+	 * Create a KubernetesClient instance.
 	 *
 	 * @return new KubernetesClient instance
 	 */

diff --git a/.../src/main/java/com/alibaba/cloud/kubernetes/config/KubernetesConfigAutoConfiguration.java b/.../src/main/java/com/alibaba/cloud/kubernetes/config/KubernetesConfigAutoConfiguration.java
@@ -30,6 +30,8 @@
 import org.springframework.context.annotation.Import;
 
 /**
+ * Spring Cloud Alibaba Kubernetes Config autoconfiguration.
+ *
  * @author Freeman
  */
 @Configuration(proxyBeanMethods = false)

diff --git a/...-config/src/main/java/com/alibaba/cloud/kubernetes/config/KubernetesConfigProperties.java b/...-config/src/main/java/com/alibaba/cloud/kubernetes/config/KubernetesConfigProperties.java
@@ -28,6 +28,8 @@
 import org.springframework.util.StringUtils;
 
 /**
+ * Spring Cloud Alibaba Kubernetes Config properties.
+ *
  * @author Freeman
  */
 @ConfigurationProperties(KubernetesConfigProperties.PREFIX)

diff --git a/...rc/main/java/com/alibaba/cloud/kubernetes/config/core/ConfigEnvironmentPostProcessor.java b/...rc/main/java/com/alibaba/cloud/kubernetes/config/core/ConfigEnvironmentPostProcessor.java
@@ -45,7 +45,9 @@
 import org.springframework.core.Ordered;
 import org.springframework.core.env.ConfigurableEnvironment;
 import org.springframework.core.env.EnumerablePropertySource;
+import org.springframework.core.env.Environment;
 import org.springframework.core.env.MutablePropertySources;
+import org.springframework.core.env.PropertySource;
 import org.springframework.core.env.StandardEnvironment;
 
 import static com.alibaba.cloud.kubernetes.config.util.Converters.toPropertySource;
@@ -54,7 +56,28 @@
 import static java.util.stream.Collectors.toList;
 
 /**
+ * Kubernetes config {@link EnvironmentPostProcessor}.
+ *
+ * <p>
+ * There are two ways to use this post processor:
+ * <ul>
+ * <li>when application starts up</li>
+ * <li>when application triggers a {@link RefreshEvent}</li>
+ * </ul>
+ *
+ * <p>
+ * When application starts up, this processor will load all the ConfigMaps/Secrets.
+ * <p>
+ * When application triggers a {@link RefreshEvent}, Spring will copy a
+ * {@link Environment} and invoke all {@link EnvironmentPostProcessor}s, then replace the
+ * {@link PropertySource} if copied {@link Environment} has the same name
+ * {@link PropertySource}. So this processor only converts the refreshed resource to
+ * {@link PropertySource} and add it to the {@link Environment} when refresh event is
+ * triggered.
+ *
  * @author Freeman
+ * @see org.springframework.cloud.context.refresh.ContextRefresher
+ * @see org.springframework.cloud.context.refresh.ConfigDataContextRefresher
  */
 public class ConfigEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered {
 	/**

diff --git a/...bernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/core/ConfigWatcher.java b/...bernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/core/ConfigWatcher.java
@@ -40,7 +40,7 @@
 import static com.alibaba.cloud.kubernetes.config.util.ResourceKeyUtils.resourceKey;
 
 /**
- * Watcher for config resource changes.
+ * Watcher for config resources change.
  *
  * @author Freeman
  */

diff --git a/...c/main/java/com/alibaba/cloud/kubernetes/config/core/HasMetadataResourceEventHandler.java b/...c/main/java/com/alibaba/cloud/kubernetes/config/core/HasMetadataResourceEventHandler.java
@@ -29,6 +29,9 @@
 import org.springframework.core.env.ConfigurableEnvironment;
 
 /**
+ * {@link HasMetadataResourceEventHandler} process {@link HasMetadata}(ConfigMap/Secret)
+ * events, trigger {@link RefreshEvent} when necessary.
+ *
  * @author Freeman
  */
 class HasMetadataResourceEventHandler<T extends HasMetadata>

diff --git a/...-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Converters.java b/...-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Converters.java
@@ -36,6 +36,8 @@
 import static java.nio.charset.StandardCharsets.UTF_8;
 
 /**
+ * {@link Converters} use to convert ConfigMap/Secret to {@link EnumerablePropertySource}.
+ *
  * @author Freeman
  */
 public final class Converters {

diff --git a/...libaba-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Pair.java b/...libaba-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Pair.java
@@ -17,6 +17,8 @@
 package com.alibaba.cloud.kubernetes.config.util;
 
 /**
+ * Utility class for holding a pair of values.
+ *
  * @author Freeman
  */
 public final class Pair<K, V> {

diff --git a/...-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Preference.java b/...-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Preference.java
@@ -17,6 +17,8 @@
 package com.alibaba.cloud.kubernetes.config.util;
 
 /**
+ * Configuration preference.
+ *
  * @author Freeman
  */
 public enum Preference {

diff --git a/...-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Processors.java b/...-kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/Processors.java
@@ -25,6 +25,8 @@
 import com.alibaba.cloud.kubernetes.config.processor.YamlFileProcessor;
 
 /**
+ * {@link Processors} holds all the {@link FileProcessor} instances.
+ *
  * @author Freeman
  */
 public final class Processors {

diff --git a/...kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/ResourceKey.java b/...kubernetes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/ResourceKey.java
@@ -19,6 +19,8 @@
 import java.util.Objects;
 
 /**
+ * {@link ResourceKey} represents identity of a resource.
+ *
  * @author Freeman
  */
 public final class ResourceKey {

diff --git a/...netes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/ResourceKeyUtils.java b/...netes-config/src/main/java/com/alibaba/cloud/kubernetes/config/util/ResourceKeyUtils.java
@@ -21,6 +21,8 @@
 import io.fabric8.kubernetes.api.model.Secret;
 
 /**
+ * {@link ResourceKeyUtils} used to generate {@link ResourceKey}.
+ *
  * @author Freeman
  */
 public final class ResourceKeyUtils {