console-kb/fixes/cncf-install/install-devfile.json at master · kubestellar/console-kb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
{
  "version": "kc-mission-v1",
  "name": "install-devfile",
  "missionClass": "install",
  "author": "KubeStellar Bot",
  "authorGithub": "kubestellar",
  "mission": {
    "title": "Install and Configure Devfile Registry on Kubernetes",
    "description": "Devfile provides a Kube-native API for cloud development workspaces. The Devfile Registry hosts reusable devfile stacks that define development environments. This mission deploys a self-hosted Devfile Registry on Kubernetes using the official Helm chart.",
    "type": "deploy",
    "status": "completed",
    "steps": [
      {
        "title": "Clone the registry-support repository",
        "description": "Clone the devfile registry-support repository which contains the Helm chart for deploying a Devfile Registry.\n```bash\ngit clone https://github.com/devfile/registry-support.git\ncd registry-support\n```"
      },
      {
        "title": "Install the Devfile Registry using Helm",
        "description": "Deploy the Devfile Registry using the included Helm chart.\n```bash\nhelm install devfile-registry deploy/chart/devfile-registry --namespace devfile --create-namespace\n```"
      },
      {
        "title": "Verify the installation",
        "description": "Check that the Devfile Registry pods are running.\n```bash\nkubectl get pods --namespace devfile\nkubectl get svc --namespace devfile\n```"
      },
      {
        "title": "Test the registry API",
        "description": "Verify the registry is serving devfile stacks by querying its API.\n```bash\nkubectl port-forward svc/devfile-registry 8080:8080 --namespace devfile &\ncurl http://localhost:8080/v2index\n```"
      }
    ],
    "resolution": {
      "summary": "A successful installation will show the Devfile Registry pods running in the devfile namespace. The registry serves devfile stacks via its REST API, allowing developers to discover and use pre-built development environment configurations.",
      "codeSnippets": [
        "git clone https://github.com/devfile/registry-support.git",
        "helm install devfile-registry deploy/chart/devfile-registry --namespace devfile --create-namespace",
        "kubectl get pods --namespace devfile"
      ]
    },
    "uninstall": [
      {
        "title": "Uninstall the Helm release",
        "description": "Remove the devfile-registry Helm release from the devfile namespace."
      },
      {
        "title": "Delete the namespace",
        "description": "Remove the devfile namespace and all associated resources."
      }
    ],
    "upgrade": [
      {
        "title": "Pull latest registry-support",
        "description": "Update the registry-support repository to get the latest Helm chart."
      },
      {
        "title": "Run helm upgrade",
        "description": "Upgrade the Devfile Registry deployment with the updated chart."
      }
    ],
    "troubleshooting": [
      {
        "title": "Registry pods not starting",
        "description": "Check pod logs for errors and ensure container images can be pulled.\n```bash\nkubectl logs -l app=devfile-registry --namespace devfile\n```"
      },
      {
        "title": "Registry returns empty index",
        "description": "Verify the registry was built with devfile stacks included. Check the registry-support build documentation for how to include custom stacks."
      }
    ]
  },
  "metadata": {
    "tags": [
      "installation",
      "configuration",
      "cncf",
      "developer-tools",
      "sandbox"
    ],
    "cncfProjects": [
      "devfile"
    ],
    "targetResourceKinds": [
      "Deployment",
      "Service",
      "Namespace"
    ],
    "difficulty": "intermediate",
    "issueTypes": [
      "installation",
      "configuration"
    ],
    "installMethods": [
      "helm"
    ],
    "maturity": "sandbox",
    "projectVersion": "v1.2.1",
    "containerImages": [
      "quay.io/devfile/devfile-index:next"
    ],
    "sourceUrls": {
      "docs": "https://devfile.io/",
      "repo": "https://github.com/devfile/api"
    },
    "qualityScore": 100
  },
  "prerequisites": {
    "kubernetes": ">=1.24",
    "tools": [
      "helm",
      "kubectl",
      "git"
    ],
    "description": "Ensure you have a Kubernetes cluster running version 1.24 or higher, along with Helm, kubectl, and git installed."
  },
  "security": {
    "scannedAt": "2026-03-18T18:00:00.000Z",
    "scannerVersion": "manual-audit",
    "sanitized": true,
    "findings": []
  }
}