diff options
5 files changed, 18 insertions, 4 deletions
diff --git a/tenant-auth/src/main/java/ai/vespa/hosted/auth/Authenticator.java b/tenant-auth/src/main/java/ai/vespa/hosted/auth/Authenticator.java index 9ded35a5726..0242d0f891b 100644 --- a/tenant-auth/src/main/java/ai/vespa/hosted/auth/Authenticator.java +++ b/tenant-auth/src/main/java/ai/vespa/hosted/auth/Authenticator.java @@ -26,7 +26,10 @@ import java.util.Optional; */ public class Authenticator { - /** Returns an SSLContext from "key" and "cert" files found under {@code System.getProperty("vespa.test.credentials.root")}. */ + /** Returns an SSLContext which provides authentication against a Vespa endpoint. + * + * If {@code System.getProperty("vespa.test.credentials.root")} is set, key and certificate files + * "key" and "cert" in that directory are used; otherwise, the system default SSLContext is returned. */ public SSLContext sslContext() { try { Path credentialsRoot = Path.of(System.getProperty("vespa.test.credentials.root")); @@ -46,10 +49,12 @@ public class Authenticator { } } + /** Adds necessary authentication to the given HTTP request builder, to be verified by a Vespa endpoint. */ public HttpRequest.Builder authenticated(HttpRequest.Builder request) { return request; } + /** Returns an authenticated controller client. */ public ControllerHttpClient controller() { ApplicationId id = ApplicationId.from(requireNonBlankProperty("tenant"), requireNonBlankProperty("application"), diff --git a/tenant-cd/src/main/java/ai/vespa/hosted/cd/Deployment.java b/tenant-cd/src/main/java/ai/vespa/hosted/cd/Deployment.java index 277632b74c7..e0abdde4687 100644 --- a/tenant-cd/src/main/java/ai/vespa/hosted/cd/Deployment.java +++ b/tenant-cd/src/main/java/ai/vespa/hosted/cd/Deployment.java @@ -13,7 +13,7 @@ public interface Deployment { /** Returns an Endpoint in the cluster with the given id. */ Endpoint endpoint(String id); - /** Returns a {@link TestDeployment} representation of this, or throws if this is a production deployment. */ + /** Returns a {@link TestDeployment} view of this, or throws if this is a production deployment. */ TestDeployment asTestDeployment(); } diff --git a/tenant-cd/src/main/java/ai/vespa/hosted/cd/TestDeployment.java b/tenant-cd/src/main/java/ai/vespa/hosted/cd/TestDeployment.java index 3360c12e374..bc00b6e0dc6 100644 --- a/tenant-cd/src/main/java/ai/vespa/hosted/cd/TestDeployment.java +++ b/tenant-cd/src/main/java/ai/vespa/hosted/cd/TestDeployment.java @@ -7,8 +7,12 @@ package ai.vespa.hosted.cd; */ public interface TestDeployment extends Deployment { + /** Returns a {@link TestEndpoint} in the cluster with the "default" id. */ + @Override TestEndpoint endpoint(); + /** Returns a {@link TestEndpoint} in the cluster with the given id. */ + @Override TestEndpoint endpoint(String id); } diff --git a/tenant-cd/src/main/java/ai/vespa/hosted/cd/http/HttpEndpoint.java b/tenant-cd/src/main/java/ai/vespa/hosted/cd/http/HttpEndpoint.java index e0d3787a21c..af66e20bbc7 100644 --- a/tenant-cd/src/main/java/ai/vespa/hosted/cd/http/HttpEndpoint.java +++ b/tenant-cd/src/main/java/ai/vespa/hosted/cd/http/HttpEndpoint.java @@ -21,9 +21,14 @@ import java.time.Duration; import static java.util.Objects.requireNonNull; +/** + * A remote endpoint in a {@link HttpDeployment} of a Vespa application, reachable over HTTP. + * + * @author jonmv + */ public class HttpEndpoint implements TestEndpoint { - static final String metricsPath = "/state/v1/metrics"; + static final String metricsPath = "/state/v1/metrics"; // TODO metrics/v1/values? static final String documentApiPath = "/document/v1"; static final String searchApiPath = "/search"; diff --git a/tenant-cd/src/main/java/ai/vespa/hosted/cd/metric/Space.java b/tenant-cd/src/main/java/ai/vespa/hosted/cd/metric/Space.java index ea771ca5dd9..a1ece1e2aa8 100644 --- a/tenant-cd/src/main/java/ai/vespa/hosted/cd/metric/Space.java +++ b/tenant-cd/src/main/java/ai/vespa/hosted/cd/metric/Space.java @@ -8,7 +8,7 @@ import java.util.stream.IntStream; import static java.util.stream.Collectors.toUnmodifiableMap; /** - * Used to easily generate points for a pre-defined space. + * Used to easily generate points (Map<String, ?>) for a space defined here by its dimension names. * * @author jonmv */ |