GitHub - weaveworks/weave-gitops: Weave GitOps core
source link: https://github.com/weaveworks/weave-gitops
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
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.4.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 gitops --namespace string Weave GitOps runtime namespace (default "wego-system") -v, --verbose Enable verbose output Use "gitops [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
- Install go v1.16
- Install buf
- make or make unit-tests to ensure everything built correctly.
unit testing
We are using Ginko for our unit tests. To exeucte the all the unit tests, run make unit-tests
.
To run a single test, you will need to set the KUBEBUILDER_ASSESTS environment variable to point to the directory containing our mock K8s objects.
export KUBEBUILDER_ASSETS=$(git rev-parse --show-toplevel)/tools/bin/envtest go test github.com/weaveworks/weave-gitops/pkg/kube
export KUBEBUILDER_ASSETS=$(git rev-parse --show-toplevel)/tools/bin/envtest cd pkg/kube go test
Executing a subset of tests
Ginkgo allows you to run a subset of Describe/Context/It specs. See Focused Specs for more information
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
- Install go v1.16
- Install Node.js version 14.15.1
- Make sure your
$GOPATH
is added to your$PATH
in your bashrc or zshrc file, then install reflex for automated server builds: go get github.com/cespare/reflex - Go through the Weave GitOps getting started docs here: https://docs.gitops.weave.works/docs/getting-started/
- Run
npm install
on this repo. - Make sure GitOps is installed on a fresh kind cluster for this repo by running
kind delete cluster
,kind create cluster
, and finallygitops install
. - To start up the HTTP server with automated re-compliation, run
make api-dev
- Run
npm start
to start the frontend dev server (with hot-reloading)
Lint frontend code with make ui-lint
- using Prettier (https://prettier.io/) will get you on the right track!
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:}).attrs({ className: ${1:}.name })``" ], "description": "Create a default-exported, styled React Component." } }
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?
- Have feature proposals or want to contribute?
- Please create a Github issue
License scan details
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK