Add javadoc for RegistryAuth
@@ -35,6 +35,17 @@ import java.nio.file.Path;
import javax.annotation.Nullable;
import org.glassfish.jersey.internal.util.Base64;
+/**
+ * Represents all the auth info for a particular registry.
+ *
+ * These are sent to docker during authenticated registry operations
+ * in the X-Registry-Config header (see {@link RegistryConfigs}).
+ *
+ * Typically these objects are built by requesting auth information from a
+ * {@link com.spotify.docker.client.DockerCredentialHelper}. However, in older less-secure
+ * docker versions, these can be written directly into the ~/.docker/config.json file,
+ * with the username and password joined with a ":" and base-64 encoded.
+ */
@AutoValue
@JsonAutoDetect(fieldVisibility = ANY, getterVisibility = NONE, setterVisibility = NONE)
public abstract class RegistryAuth {
