openfaas/ofc-bootstrap

[Feature] Add check command

Open

#173 opened on Dec 29, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (61 forks)auto 404
help wantedsize/lskill/intermediate

Repository metrics

Stars
 (177 stars)
PR merge metrics
 (PR metrics pending)

Description

This feature would add a ‘ofc-bootstrap check -f init.yaml’ command which would run through a number of diagnostics and advise the user of the status of their deployment.

To start with, these items would be of most value to check:

  • Were secrets created?
  • Is OpenFaaS deployed?
  • Does the gateway respond?
  • Is the advertised DNS valid and pointing to the correct domain?
  • Is cert-manager available?
  • Is the registry credential valid?

Contributor guide

Research direction
Explore the existing command structure, especially how the 'init' command is implemented. Identify reusable functions for checking deployments and services. Create a new 'check' command following the same pattern, implementing each diagnostic from the issue. Write tests for each check.
Tech stack
gokubernetes
Domain
clidevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGoKubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65