Add docs.

Author: chenkins

admin-cli/src/main/java/cloud/katta/cli/commands/AuthorizationCode.java

@@ -10,7 +10,10 @@
 import io.github.coffeelibs.tinyoauth2client.TinyOAuth2;
 import picocli.CommandLine;
 
-// https://github.com/cryptomator/hub-cli/commit/bffcf2805530976c4a758990958ff75f9df68c0e#diff-c349f933a7698e31cfe25bd0a638ae487a02ac6fcb429bcce3e315aa8832be8b
+
+/**
+ * Based on <a href="https://github.com/cryptomator/hub-cli/commit/bffcf2805530976c4a758990958ff75f9df68c0e#diff-c349f933a7698e31cfe25bd0a638ae487a02ac6fcb429bcce3e315aa8832be8b">hub-cli</a>.
+ */
 @CommandLine.Command(name = "authorizationCode", description = "Get token using authorization code flow.", mixinStandardHelpOptions = true)
 public class AuthorizationCode implements Callable<Void> {
 

admin-cli/src/main/java/cloud/katta/cli/commands/AwsSTSSetup.java

@@ -38,6 +38,21 @@
 import software.amazon.awssdk.services.iam.model.UpdateAssumeRolePolicyRequest;
 import software.amazon.awssdk.services.iam.model.UpdateOpenIdConnectProviderThumbprintRequest;
 
+/**
+ * Sets up AWS for Katta in STS mode:
+ * <ul>
+ *  <li> creates/updates OIDC provider for cryptomator, cryptomatorhub and cryptomatorvaults clients.</li>
+ *  <li> creates roles and role policy for
+ *      <ul>
+ *          <li>creating vaults: access restricted to creating buckets with given prefix</li>
+ *          <li> accessing vaults using <a href="role chaining">https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html</a>: access restricted to reading/writing to single bucket.</li>
+ *      </ul>
+ *  </li>
+ * </ul>
+ * Requires <code>admin</code> role in Katta Server.
+ * <p>
+ * See also: <a href="https://github.com/shift7-ch/katta-docs/blob/main/SETUP_KATTA_SERVER.md#setup-aws">Katta Docs</a>.
+ */
 @CommandLine.Command(name = "awsSetup", description = "Setup/update OIDC provider and roles for STS in AWS.", mixinStandardHelpOptions = true)
 public class AwsSTSSetup implements Callable<Void> {
 

admin-cli/src/main/java/cloud/katta/cli/commands/StorageProfileAWSSTSSetup.java

@@ -4,6 +4,11 @@
 
 package cloud.katta.cli.commands;
 
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.UUID;
+import java.util.concurrent.Callable;
+
 import cloud.katta.client.ApiClient;
 import cloud.katta.client.ApiException;
 import cloud.katta.client.api.StorageProfileResourceApi;
@@ -13,11 +18,13 @@
 import cloud.katta.client.model.StorageProfileS3STSDto;
 import picocli.CommandLine;
 
-import java.io.IOException;
-import java.util.Arrays;
-import java.util.UUID;
-import java.util.concurrent.Callable;
-
+/**
+ * Uploads a storage profile to Katta Server for use with AWS STS. Requires AWS STS setup.
+ * <p>
+ * The storage profile then allows users with <code>create-vaults</code> role to create vaults and their corresponding S3 bucket seamlessly.
+ * <p>
+ * See also: <a href="https://github.com/shift7-ch/katta-docs/blob/main/SETUP_KATTA_SERVER.md#storage-profiles">katta docs</a>.
+ */
 @CommandLine.Command(name = "storageProfileAWSSTS",
         description = "Upload storage profile for AWS STS.",
         mixinStandardHelpOptions = true)

admin-cli/src/main/java/cloud/katta/cli/commands/StorageProfileAWSStaticSetup.java

@@ -16,6 +16,12 @@
 import cloud.katta.client.model.StorageProfileS3Dto;
 import picocli.CommandLine;
 
+/**
+ * Uploads a storage profile to Katta Server for use with AWS static.
+ * The storage profile then allows users with <code>create-vaults</code> role to create vaults for an existing AWS S3 bucket.
+ * <p>
+ * See also: <a href="https://github.com/shift7-ch/katta-docs/blob/main/SETUP_KATTA_SERVER.md#storage-profiles">katta docs</a>.
+ */
 @CommandLine.Command(name = "storageProfileAWSStatic",
         description = "Upload storage profile for AWS Static.",
         mixinStandardHelpOptions = true)

admin-cli/src/main/java/cloud/katta/cli/commands/StorageProfileArchive.java

@@ -12,6 +12,13 @@
 import cloud.katta.client.api.StorageProfileResourceApi;
 import picocli.CommandLine;
 
+/**
+ * Archives a storage profile using <code>/api/storageprofile</code>.
+ * <p>
+ * Requires <code>admin</code> role in Katta Server.
+ * <p>
+ * See also <a href="https://github.com/shift7-ch/katta-clientlib/blob/main/hub/src/main/resources/openapi.json>OpenAPI Specification</a>.
+ */
 @CommandLine.Command(name = "storageProfileArchive",
         description = "Upload storage profile for AWS Static.",
         mixinStandardHelpOptions = true)