Skip to content

Commit d967bdf

Browse files
authored
Add correct default for natsURL (#337)
* Add correct default for natsURL - Will work without configuration if using `gitops upgrade` * Fixes accidental readme overwrite * Revert test focusing
1 parent 8452484 commit d967bdf

File tree

3 files changed

+6
-170
lines changed

3 files changed

+6
-170
lines changed

README.md

Lines changed: 4 additions & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -1,170 +1,6 @@
1-
# weave-gitops
1+
# weave-gitops-enterprise
22

3-
Weave GitOps
3+
Information
44

5-
[![Coverage Status](https://coveralls.io/repos/github/weaveworks/weave-gitops/badge.svg?branch=main)](https://coveralls.io/github/weaveworks/weave-gitops?branch=main)
6-
![Test status](https://github.com/weaveworks/weave-gitops/actions/workflows/test.yml/badge.svg)
7-
[![LICENSE](https://img.shields.io/github/license/weaveworks/weave-gitops)](https://github.com/weaveworks/weave-gitops/blob/master/LICENSE)
8-
[![Contributors](https://img.shields.io/github/contributors/weaveworks/weave-gitops)](https://github.com/weaveworks/weave-gitops/graphs/contributors)
9-
[![Release](https://img.shields.io/github/v/release/weaveworks/weave-gitops?include_prereleases)](https://github.com/weaveworks/weave-gitops/releases/latest)
10-
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B19155%2Fgithub.com%2Fweaveworks%2Fweave-gitops.svg?type=shield)](https://app.fossa.com/reports/005da7c4-1f10-4889-9432-8b97c2084e41)
11-
12-
## Overview
13-
14-
Weave GitOps enables an effective GitOps workflow for continuous delivery of applications into Kubernetes clusters.
15-
It is based on [CNCF Flux](https://fluxcd.io), a leading GitOps engine.
16-
17-
## Getting Started
18-
19-
### CLI Installation
20-
21-
Mac / Linux
22-
23-
```console
24-
curl -L "https://github.com/weaveworks/weave-gitops/releases/download/v0.4.1/gitops-$(uname)-$(uname -m)" -o gitops
25-
chmod +x gitops
26-
sudo mv ./gitops /usr/local/bin/gitops
27-
gitops version
28-
```
29-
30-
Please see the [getting started guide](https://docs.gitops.weave.works/docs/getting-started).
31-
32-
## CLI Reference
33-
34-
```console
35-
Weave GitOps
36-
Command line utility for managing Kubernetes applications via GitOps.
37-
38-
Usage:
39-
gitops [command]
40-
41-
Available Commands:
42-
app Add or status application
43-
flux Use flux commands
44-
help Help about any command
45-
install Install or upgrade Weave GitOps
46-
ui Manages Weave GitOps UI
47-
uninstall Uninstall Weave GitOps
48-
version Display Weave GitOps version
49-
50-
Flags:
51-
-h, --help Help for gitops
52-
--namespace string The namespace scope for this operation (default "wego-system").
53-
-v, --verbose Enable verbose output
54-
55-
Use "gitops [command] --help" for more information about a command.
56-
```
57-
58-
For more information please see the [docs](https://docs.gitops.weave.works/docs/cli-reference)
59-
60-
## CLI/API development
61-
62-
To set up a development environment for the CLI
63-
64-
1. Install go v1.16
65-
2. Install [buf](https://github.com/bufbuild/buf)
66-
3. make or make unit-tests to ensure everything built correctly.
67-
68-
### unit testing
69-
70-
We are using [Ginko](https://onsi.github.io/ginkgo/) for our unit tests. To execute the all the unit tests, run `make unit-tests`.
71-
72-
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.
73-
74-
```bash
75-
export KUBEBUILDER_ASSETS=$(git rev-parse --show-toplevel)/tools/bin/envtest
76-
go test github.com/weaveworks/weave-gitops/pkg/kube
77-
```
78-
79-
or
80-
81-
```bash
82-
export KUBEBUILDER_ASSETS=$(git rev-parse --show-toplevel)/tools/bin/envtest
83-
cd pkg/kube
84-
go test
85-
```
86-
87-
#### Executing a subset of tests
88-
89-
Ginkgo allows you to run a subset of Describe/Context/It specs. See [Focused Specs](https://onsi.github.io/ginkgo/#focused-specs) for more information
90-
91-
### Setup golangci-lint in your editor
92-
93-
Link for golangci-lint editor integration: https://golangci-lint.run/usage/integrations/
94-
95-
For VSCode, use these editor configuration flags:
96-
97-
```json
98-
"go.lintFlags": [
99-
"--fast",
100-
],
101-
```
102-
103-
## UI Development
104-
105-
To set up a development environment for the UI
106-
107-
1. Install go v1.16
108-
2. Install Node.js version 14.15.1
109-
3. 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
110-
4. Go through the Weave GitOps getting started docs here: https://docs.gitops.weave.works/docs/getting-started/
111-
5. Run `npm install` on this repo.
112-
6. Make sure GitOps is installed on a fresh kind cluster for this repo by running `kind delete cluster`, `kind create cluster`, and finally `gitops install`.
113-
7. To start up the HTTP server with automated re-compliation, run `make api-dev`
114-
8. Run `npm start` to start the frontend dev server (with hot-reloading)
115-
116-
Lint frontend code with `make ui-lint` - using Prettier (https://prettier.io/) will get you on the right track!
117-
118-
Run frontend tests with `make ui-test` - update CSS snapshots with `npm run test -- -u`
119-
120-
Check dependency vulnerabilities with `make ui-audit`
121-
122-
### Recommended Snippets
123-
124-
To create a new styled React component (with typescript):
125-
126-
```json
127-
{
128-
"Export Default React Component": {
129-
"prefix": "tsx",
130-
"body": [
131-
"import * as React from 'react';",
132-
"import styled from 'styled-components'",
133-
"",
134-
"type Props = {",
135-
" className?: string",
136-
"}",
137-
"",
138-
"function ${1:} ({ className }: Props) {",
139-
" return (",
140-
" <div className={className}>",
141-
" ${0}",
142-
" </div>",
143-
" );",
144-
"}",
145-
"",
146-
"export default styled(${1:}).attrs({ className: ${1:}.name })``"
147-
],
148-
"description": "Create a default-exported, styled React Component."
149-
}
150-
}
151-
```
152-
153-
## FAQ
154-
155-
Please see our Weave GitOps Core [FAQ](https://www.weave.works/faqs-for-weave-gitops-core/)
156-
157-
## Contribution
158-
159-
Need help or want to contribute? Please see the links below.
160-
161-
- Getting Started?
162-
- Follow our [Get Started guide](https://docs.gitops.weave.works/docs/getting-started) and give us feedback
163-
- Need help?
164-
- Talk to us in the [#weave-gitops channel](https://app.slack.com/client/T2NDH1D9D/C0248LVC719/thread/C2ND76PAA-1621532937.019800) on Weaveworks Community Slack. [Invite yourself if you haven't joined yet.](https://slack.weave.works/)
165-
- Have feature proposals or want to contribute?
166-
- Please create a [Github issue](https://github.com/weaveworks/weave-gitops/issues)
167-
168-
## License scan details
169-
170-
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B19155%2Fgithub.com%2Fweaveworks%2Fweave-gitops.svg?type=large)](https://app.fossa.com/reports/005da7c4-1f10-4889-9432-8b97c2084e41)
5+
- Dev guide in [docs/developing.md](./docs/developing.md)
6+
- User docs at https://docs.gitops.weave.works

charts/mccp/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ gitopsRepoBroker:
6363

6464
agentTemplate:
6565
natsScheme: nats
66-
natsURL: nats-client.wkp-mccp:4222
66+
natsURL: weave-gitops-enterprise-nats-client.wego-system:4222
6767

6868
nats:
6969
auth:

test/acceptance/test/ui_clusters.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ func DescribeClusters(gitopsTestRunner GitopsTestRunner) {
552552
})
553553
})
554554

555-
FIt("Verify clicking on alert name in alerts widget will take to the cluster page", func() {
555+
It("Verify clicking on alert name in alerts widget will take to the cluster page", func() {
556556
if getEnv("ACCEPTANCE_TESTS_DATABASE_TYPE", "") == "postgres" {
557557
Skip("This test case runs only with sqlite")
558558
}

0 commit comments

Comments
 (0)