README.md

weave-gitops

Weave GitOps

Overview

Weave GitOps enables an effective GitOps workflow for continuous delivery of applications into Kubernetes clusters. It is based on CNCF Flux, a leading GitOps engine.

Getting Started

CLI Installation

Mac / Linux

curl -L "https://github.com/weaveworks/weave-gitops/releases/download/v0.3.0/gitops-$(uname)-$(uname -m)" -o gitops
chmod +x gitops
sudo mv ./gitops /usr/local/bin/gitops
gitops version

Please see the getting started guide.

CLI Reference

Weave GitOps
Command line utility for managing Kubernetes applications via GitOps.

Usage:
  gitops [command]

Available Commands:
  app         Add or status application
  flux        Use flux commands
  help        Help about any command
  install     Install or upgrade Weave GitOps
  ui          Manages Weave GitOps UI
  uninstall   Uninstall Weave GitOps
  version     Display Weave GitOps version

Flags:
  -h, --help               help for wego
      --namespace string   gitops runtime namespace (default "wego-system")
  -v, --verbose            Enable verbose output

Use "wego [command] --help" for more information about a command.

For more information please see the docs

CLI/API development

To set up a development environment for the CLI

1. Install go v1.16
2. Install buf
3. make

Setup golangci-lint in your editor

Link for golangci-lint editor integration: https://golangci-lint.run/usage/integrations/

For VSCode, use these editor configuration flags:

    "go.lintFlags": [
        "--fast",
    ],

UI Development

To set up a development environment for the UI

1. Install go v1.16
2. Install Node.js version 14.15.1
3. Install reflex for automated server builds: go get github.com/cespare/reflex
4. Run npm install
5. To start up the HTTP server with automated re-compliation, run make ui-dev
6. Run npm start to start the frontend dev server (with hot-reloading)

Lint frontend code with make ui-lint

Run frontend tests with make ui-test

Check dependency vulnerabilities with make ui-audit

Recommended Snippets

To create a new styled React component (with typescript):

{
  "Export Default React Component": {
    "prefix": "tsx",
    "body": [
      "import * as React from 'react';",
      "import styled from 'styled-components'",
      "",
      "type Props = {",
      "  className?: string",
      "}",
      "",
      "function ${1:} ({ className }: Props) {",
      "  return (",
      "    <div className={className}>",
      "      ${0}",
      "    </div>",
      "  );",
      "}",
      "",
      "export default styled(${1:})``"
    ],
    "description": "Create a default-exported, styled React Component."
  }
}

FAQ

Please see our Weave GitOps Core FAQ

Contribution

Need help or want to contribute? Please see the links below.

• Getting Started?
  • Follow our Get Started guide and give us feedback
• Need help?
  • Talk to us in the #weave-gitops channel on Weaveworks Community Slack. Invite yourself if you haven't joined yet.
• Have feature proposals or want to contribute?
  • Please create a Github issue

License scan details