Skip to content

Commit

Permalink
Merge pull request #9534 from richardblack-Harness/AH-995/pull-push
Browse files Browse the repository at this point in the history
docs: [AH-995]: Add client setup doc
  • Loading branch information
richardblack-Harness authored Feb 28, 2025
2 parents 220dc8f + 8b75f52 commit 7508d2a
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,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
Expand Down
30 changes: 30 additions & 0 deletions docs/artifact-registry/manage-registries/client-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Client Setup
description: Configure your client to pull and push artifact registries
sidebar_position: 30
---

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.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Delete Registries
description: Learn how to delete an artifact registry.
sidebar_position: 30
sidebar_position: 40
---

:::warning
Expand Down
3 changes: 1 addition & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down Expand Up @@ -570,7 +570,6 @@ const sidebars: SidebarsConfig = {
collapsed: true,
items: [ { type: "autogenerated", dirName: "artifact-registry/platform-integrations", } ],
},

{
type: "html",
value: "Troubleshooting & Resources",
Expand Down

0 comments on commit 7508d2a

Please sign in to comment.