{"id":19865657,"url":"https://github.com/openfaas/config-checker","last_synced_at":"2025-05-02T05:31:50.127Z","repository":{"id":58647349,"uuid":"532875647","full_name":"openfaas/config-checker","owner":"openfaas","description":"Check your OpenFaaS Configuration","archived":false,"fork":false,"pushed_at":"2023-11-17T14:08:58.000Z","size":59,"stargazers_count":6,"open_issues_count":4,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T23:07:35.420Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-09-05T11:44:14.000Z","updated_at":"2023-10-06T10:19:24.000Z","dependencies_parsed_at":"2023-10-31T22:25:53.655Z","dependency_job_id":null,"html_url":"https://github.com/openfaas/config-checker","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Fconfig-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Fconfig-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Fconfig-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfaas%2Fconfig-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfaas","download_url":"https://codeload.github.com/openfaas/config-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251992937,"owners_count":21677022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T15:23:37.645Z","updated_at":"2025-05-02T05:31:45.112Z","avatar_url":"https://github.com/openfaas.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Check your OpenFaaS Configuration\n\nThis is a diagnostic tool meant for OpenFaaS users to check the configuration of their Kubernetes cluster. It's written by the team that provide Enteprise Support to paying customers.\n\nIt runs just once (inside your cluster) to check your functions and the way OpenFaaS itself is configured.\n\nSee also: [Troubleshooting OpenFaaS](https://docs.openfaas.com/deployment/troubleshooting/)\n\n## How it works\n\nYou deploy a one-time Kubernetes job that runs some queries against the Kubernetes API using [a limited RBAC definition](https://github.com/openfaas/config-checker/blob/master/artifacts/rbac.yaml). The results are printed to the pod's logs.\n\nIt's completely offline. There is no call-home or data transferred to any third-party.\n\nYou must email the results to us, or attach them to a Slack conversation.\n\n## What's collected\n\nOpenFaaS core components:\n\n* Whether you're using OpenFaaS Pro\n* Which image tags you're using\n* Timeout values\n\nFunctions:\n\n* Function names\n* Auto-scaling settings\n* The number of replicas for each function\n\n## What's not collected\n\nConfidential data, secrets, other environment variables.\n\n## Run the job and collect the results (automated)\n\nDownload [run-job from GitHub](https://github.com/alexellis/run-job) or [use \"arkade get\"](https://arkade.dev/)\n\n```bash\n# Apply the RBAC file\nkubectl apply -f https://raw.githubusercontent.com/openfaas/config-checker/master/artifacts/rbac.yaml\n\n# Install run-job to run the job and collect the results\narkade get run-job\n\n# Download the job definition\ncurl -SLs \\\n  -f https://raw.githubusercontent.com/openfaas/config-checker/master/job.yaml \\\n  -o /tmp/job.yaml\n\n# Output to file with today's date\n$HOME/.arkade/bin/run-job \\\n    -f /tmp/job.yaml \\\n    --out $(date '+%Y-%m-%d_%H_%M_%S').txt\n\n# Or print to console:\n$HOME/.arkade/bin/run-job -f /tmp/job.yaml\n\n# run-job will try to run `pwd`/job.yaml, so you can also skip the argument\ncd /tmp/\n$HOME/.arkade/bin/run-job\n```\n\n## Run the job and collect the results (with kubectl only)\n\nFor run of the tool, run all steps 1-3.\n\n1) Deploy the job:\n\n```bash\n#!/bin/bash\n\ngit clone --depth=1 https://github.com/openfaas/config-checker\n\ncd config-checker\n\n# Delete any prior runs\nkubectl delete -f ./artifacts/\n\nkubectl apply -f ./artifacts/\n```\n\n2) Collect the results from the logs:\n\n```bash\n#!/bin/bash\n\nJOBNAME=\"checker\"\nJOBUUID=$(kubectl get job -n openfaas $JOBNAME -o \"jsonpath={.metadata.labels.controller-uid}\")\nPODNAME=$(kubectl get po -n openfaas -l controller-uid=$JOBUUID -o name)\n\nkubectl logs -n openfaas $PODNAME \u003e $(date '+%Y-%m-%d_%H_%M_%S').txt\n```\n\n3) Remove the job and its RBAC permissions:\n\n```bash\nkubectl delete -f ./artifacts\n```\n\n## Making sense of the results\n\nFeel free to get in touch with us to discuss the results: [contact us](https://openfaas.com/support)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfaas%2Fconfig-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfaas%2Fconfig-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfaas%2Fconfig-checker/lists"}