Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [AH-809]: Add AH troubleshooting section and horizontal sidebars #8950

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/artifact-registry/troubleshooting/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Troubleshooting",
"collapsible": "false",
"collapsed": "true",
"link": { "type": "generated-index", "title": "Troubleshooting" },
"customProps": {},
"position": 60
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Authorization / Authentication",
"collapsible": "true",
"collapsed": "false",
"link": { "type": "generated-index", "title": "Authorization / Authentication" },
"customProps": {},
"position": 10
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Issues Pulling Images
description: Fixing 401 Unauthorized errors when pulling images from Harness Artifact Registry.
sidebar_position: 10
---

This document provides steps to resolve "401 Unauthorized" errors when pulling images from Harness Artifact Registry.

## Understanding 401 Errors When Pulling Images

401 Unauthorized errors occur when Harness Artifact Registry fails to authenticate image pull requests from the Kubernetes cluster.

:::tip Cluster Secrets
Ensure your cluster has the correct `imagePullSecrets` and Kubernetes secrets configured.
:::

### Example Solution

To authenticate your Kubernetes cluster, follow these steps:

1. **Create a Docker Registry Secret:**

```bash
kubectl create secret docker-registry docker-registry-secret1 \
--docker-server=pkg.harness.io \
--docker-username=<email> \
--docker-password=<personal-access-token> \
--docker-email=<email> \
--namespace=default
```

2. **Update your Kubernetes deployment manifest to reference the secret:**
```bash
apiVersion: v1
kind: Pod
metadata:
name: your-pod-name
namespace: default
spec:
containers:
- name: your-container-name
image: pkg.harness.io/your-image:tag
imagePullSecrets:
- name: docker-registry-secret1
```

3. **Verify the Setup:**

Deploy the updated manifest and monitor the pod status to ensure the image is pulled successfully without authentication errors.

---

## Kubernetes-specific guides
Go to the [Private Registry for Kubernetes guide](https://developer.harness.io/docs/continuous-delivery/deploy-srv-diff-platforms/kubernetes/cd-kubernetes-category/pull-an-image-from-a-private-registry-for-kubernetes/) or [Add Container Images as Artifacts](https://developer.harness.io/docs/continuous-delivery/deploy-srv-diff-platforms/kubernetes/cd-kubernetes-category/add-artifacts-for-kubernetes-deployments/) for more details on how to pull an image from a private registry, or to add container images as artifacts for Kubernetes deployments.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 403 Errors in Pipeline Execution
description: Troubleshooting common 403 errors during pipeline execution in Harness Artifact Registry.
sidebar_position: 20
---

This document helps you troubleshoot 403 errors encountered during pipeline execution.

## Understanding 403 Errors in Pipeline Execution
403 errors typically indicate a permissions or access-related issue in your pipeline setup. They may arise due to configuration changes or mismatched access credentials. Go to [role-based access control (RBAC)](https://developer.harness.io/docs/platform/role-based-access-control/rbac-in-harness) to find out how to manage pipeline permissions.

:::tip account level access
Check if any recent changes to account-level flags or permissions may have impacted the pipeline.
:::

Go to the [permission reference](https://developer.harness.io/docs/platform/role-based-access-control/permissions-reference/) to review the specific permissions required for your pipeline execution.
58 changes: 57 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,63 @@ const sidebars = {
description: "Learn how to store artifacts securely.",
},
collapsed: true,
items: [{ type: "autogenerated", dirName: "artifact-registry" }],
items: [
"artifact-registry/whats-supported",
],
},
{
type: "html",
value: "New to Artifact Registry?",
className: "horizontal-bar",
},
"artifact-registry/get-started/overview",
"artifact-registry/get-started/quickstart",
{
type: "html",
value: "Use Artifact Registry",
className: "horizontal-bar",
},
{
type: "category",
label: "Manage Registries",
link: {
type: "generated-index",
},
collapsed: true,
items: [ { type: "autogenerated", dirName: "artifact-registry/manage-registries", } ],
},
{
type: "category",
label: "Manage Artifacts",
link: {
type: "generated-index",
},
collapsed: true,
items: [ { type: "autogenerated", dirName: "artifact-registry/manage-artifacts", } ],
},
{
type: "category",
label: "Platform Integrations",
link: {
type: "generated-index",
},
collapsed: true,
items: [ { type: "autogenerated", dirName: "artifact-registry/platform-integrations", } ],
},

{
type: "html",
value: "Troubleshooting",
className: "horizontal-bar",
},
{
type: "category",
label: "Authorization & Authentication",
link: {
type: "generated-index",
},
collapsed: true,
items: [ { type: "autogenerated", dirName: "artifact-registry/troubleshooting/authorization", } ],
},
// API Docs
{
Expand Down
3 changes: 1 addition & 2 deletions src/components/HomepageFeatures/data/featureListData.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ export const featureList: CardItem[] = [
module: MODULES.ar,
icon: "img/icon_artifact_registry.svg",
description: "Store your binaries natively on Harness.",
link: "docs/artifact-registry/get-started/overview",
type: [docType.Documentation],
link: "docs/artifact-registry",
},
{
title: "Set up CD Pipelines",
Expand Down
Loading