From 683e0bc4c99f8ae69667edbe136da9763ef5a71e Mon Sep 17 00:00:00 2001 From: richardblack-Harness Date: Thu, 27 Feb 2025 08:53:28 +0000 Subject: [PATCH 1/2] AH-995 Add client setup doc --- .github/CODEOWNERS | 4 ++-- docs/artifact-registry/client-setup.md | 30 ++++++++++++++++++++++++++ sidebars.ts | 4 ++-- 3 files changed, 34 insertions(+), 4 deletions(-) create mode 100644 docs/artifact-registry/client-setup.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0c7ab15d0e..087272ab61 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -190,8 +190,8 @@ static/ @rohanmaharjan100 @wei-harness /docs/ai-qa-assistant/ # Artifact Registry Docs -/docs/artifact-registry/ @shankaranandh @shivagowda @richardblack-Harness -/src/components/Docs/data/artifactRegistryData.ts @shankaranandh @shivagowda @richardblack-Harness +/docs/artifact-registry/ @shankaranandh @shivagowda @richardblack-Harness @poojaSinghal @arvind-choudhary-h +/src/components/Docs/data/artifactRegistryData.ts @shankaranandh @shivagowda @richardblack-Harness @poojaSinghal @arvind-choudhary-h #FME Docs /src/components/Roadmap/data/fmeData.ts @dtk-DaveKarow @kleinjoshuaa @deej-split diff --git a/docs/artifact-registry/client-setup.md b/docs/artifact-registry/client-setup.md new file mode 100644 index 0000000000..83c9a0eda2 --- /dev/null +++ b/docs/artifact-registry/client-setup.md @@ -0,0 +1,30 @@ +--- +title: Client Setup +description: Configure your client to pull and push artifact registries +sidebar_position: 10 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Harness Artifact Registry provides a secure, centralized way to manage artifacts for deployments. Before using artifacts, configure your environment with the Client Setup feature. + +:::tip create a registry +If you haven’t created a registry yet, see [create a registry](/docs/artifact-registry/manage-registries/create-registry). +::: + +Client Setup simplifies authentication and ensures proper configuration for different artifact types (e.g., container images, Helm charts). It also helps prevent common misconfigurations when pulling or pushing artifacts. + +## Client setup +1. Select **Registries**, then select a container register of type `ARTIFACT REGISTRY`, e.g. Docker or Maven. +2. Select **Set up client**. +3. Follow the on-screen instructions. + +### Configuration steps +The Client Setup process provides step-by-step guidance, including: +- Logging in to the registry. +- Generating a password token. +- Pulling an image or package. +- Pushing an image or package. + +Now, you should see the artifact appear in your docker registry as well as the **Artifacts** tab in the left navigation panel. \ No newline at end of file diff --git a/sidebars.ts b/sidebars.ts index f59c93e8e4..6b7373ea45 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -50,7 +50,7 @@ const sidebars: SidebarsConfig = { // Artifact Registry landing page { type: "link", - label: "Artifact Registry (BETA)", + label: "Artifact Registry ", className: "sidebar-ar", href: "/docs/artifact-registry", customProps: { @@ -561,6 +561,7 @@ const sidebars: SidebarsConfig = { collapsed: true, items: [ { type: "autogenerated", dirName: "artifact-registry/manage-artifacts", } ], }, + "artifact-registry/client-setup", { type: "category", label: "Platform Integrations", @@ -570,7 +571,6 @@ const sidebars: SidebarsConfig = { collapsed: true, items: [ { type: "autogenerated", dirName: "artifact-registry/platform-integrations", } ], }, - { type: "html", value: "Troubleshooting & Resources", From 8b75f52bb027935a5912bc2b91918578af77b366 Mon Sep 17 00:00:00 2001 From: richardblack-Harness Date: Thu, 27 Feb 2025 12:32:28 +0000 Subject: [PATCH 2/2] AH-995 Update client setup placement --- docs/artifact-registry/{ => manage-registries}/client-setup.md | 2 +- docs/artifact-registry/manage-registries/delete-registry.md | 2 +- sidebars.ts | 1 - 3 files changed, 2 insertions(+), 3 deletions(-) rename docs/artifact-registry/{ => manage-registries}/client-setup.md (98%) diff --git a/docs/artifact-registry/client-setup.md b/docs/artifact-registry/manage-registries/client-setup.md similarity index 98% rename from docs/artifact-registry/client-setup.md rename to docs/artifact-registry/manage-registries/client-setup.md index 83c9a0eda2..66c8e5bc5f 100644 --- a/docs/artifact-registry/client-setup.md +++ b/docs/artifact-registry/manage-registries/client-setup.md @@ -1,7 +1,7 @@ --- title: Client Setup description: Configure your client to pull and push artifact registries -sidebar_position: 10 +sidebar_position: 30 --- import Tabs from '@theme/Tabs'; diff --git a/docs/artifact-registry/manage-registries/delete-registry.md b/docs/artifact-registry/manage-registries/delete-registry.md index 0d04b35dcd..4e6f40055f 100644 --- a/docs/artifact-registry/manage-registries/delete-registry.md +++ b/docs/artifact-registry/manage-registries/delete-registry.md @@ -1,7 +1,7 @@ --- title: Delete Registries description: Learn how to delete an artifact registry. -sidebar_position: 30 +sidebar_position: 40 --- :::warning diff --git a/sidebars.ts b/sidebars.ts index 6b7373ea45..3f5379a966 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -561,7 +561,6 @@ const sidebars: SidebarsConfig = { collapsed: true, items: [ { type: "autogenerated", dirName: "artifact-registry/manage-artifacts", } ], }, - "artifact-registry/client-setup", { type: "category", label: "Platform Integrations",