GitOps ゾンビ

このシンプルなツールは、GitOps (flux2) 経由で管理されていない kubernetes リソースを見つけるのに役立ちます。

どのように機能するのでしょうか?

gitops-zombies は、クラスターにインストールされているすべての API を検出し、Kustomization または HelmRelease の一部ではないリソースを特定します。また、次の事実も認めています。

親リソースが所有するリソース (デプロイメントによって作成されたポッドなど) を無視します。
動的とみなされるリソース (メトリック、リース、イベント、エンドポイントなど) を無視します。
API サーバー自体によって作成されたリソース (デフォルトの rbacs など) をフィルターで除外します。
Helm や ServiceAccount トークンなど、他の当事者によって管理されているシークレットをフィルターします。
参照された HelmRelease または Kustomization が存在するかどうかを確認します
リソースがまだカスタム化インベントリの一部であるかどうかを確認します
クラスター間のカスタマイズをサポート

どうやってインストールすればいいのでしょうか？

brew tap raffis/gitops-zombies
brew install gitops-zombies

使用方法

gitops-zombies

より高度な呼び出しには、(組み込みの除外以外に) 動的と見なされる特定のリソースを除外する次のようなフィルターが含まれる場合があります。

gitops-zombies --context staging -l app.kubernetes.io/managed-by!=kops,app.kubernetes.io/name!=velero,io.cilium.k8s.policy.cluster!=default

また、名前に基づいて特定のリソースを除外したい場合もあります。これは、YAML 構成を通じて実現できます。

 ---apiVersion: gitopszombies/v1kind: ConfigexcludeResources:
- 名前: デフォルト
  APIバージョン: v1
  種類: ServiceAccount- 名前: velero-capi-backup-.*
  名前空間: velero
  APIバージョン: velero.io/v1
  種類: バックアップ
  クラスター:管理

CLI リファレンス

Finds all kubernetes resources from all installed apis on a kubernetes cluste and evaluates whether they are managed by a flux kustomization or a helmrelease.

Usage:
  gitops-zombies [flags]

Flags:
      --add_dir_header                   If true, adds the file directory to the header of the log messages
      --alsologtostderr                  log to standard error as well as files (no effect when -logtostderr=true)
      --as string                        Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
      --as-group stringArray             Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --as-uid string                    UID to impersonate for the operation.
      --cache-dir string                 Default cache directory (default "~/.kube/cache")
      --certificate-authority string     Path to a cert file for the certificate authority
      --client-certificate string        Path to a client certificate file for TLS
      --client-key string                Path to a client key file for TLS
      --cluster string                   The name of the kubeconfig cluster to use
      --config string                    Config file (default "~/.gitops-zombies.yaml")
      --context string                   The name of the kubeconfig context to use
      --disable-compression              If true, opt-out of response compression for all requests to the server
      --exclude-cluster strings          Exclude cluster from zombie detection (default none)
      --fail                             Exit with an exit code > 0 if zombies are detected
  -h, --help                             help for gitops-zombies
  -a, --include-all                      Includes resources which are considered dynamic resources
      --insecure-skip-tls-verify         If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kubeconfig string                Path to the kubeconfig file to use for CLI requests.
      --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
      --log_dir string                   If non-empty, write log files in this directory (no effect when -logtostderr=true)
      --log_file string                  If non-empty, use this log file (no effect when -logtostderr=true)
      --log_file_max_size uint           Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
      --logtostderr                      log to standard error instead of files (default true)
  -n, --namespace string                 If present, the namespace scope for this CLI request
      --no-stream                        Display discovered resources at the end instead of live
      --one_output                       If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
  -o, --output string                    Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns [https://kubernetes.io/docs/reference/kubectl/overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/].
      --request-timeout string           The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  -l, --selector string                  Label selector (Is used for all apis)
  -s, --server string                    The address and port of the Kubernetes API server
      --skip_headers                     If true, avoid header prefixes in the log messages
      --skip_log_headers                 If true, avoid headers when opening log files (no effect when -logtostderr=true)
      --stderrthreshold severity         logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=false) (default 2)
      --tls-server-name string           Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
      --token string                     Bearer token for authentication to the API server
      --user string                      The name of the kubeconfig user to use
  -v, --v Level                          number for the log level verbosity
      --version                          Print version and exit
      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging

拡大する

追加情報