Browse Source

nitpick: `flux` -> `Flux`

for those bean-counters in the audience I timed it: this change took 2m21s
Dimitri Mitropoulos 5 months ago
parent
commit
08c2b422b9

+ 8
- 8
CHANGELOG.md View File

@@ -3,8 +3,8 @@ operator is in [./CHANGELOG-helmop.md](./CHANGELOG-helmop.md).
3 3
 
4 4
 ## 1.10.1 (2019-02-13)
5 5
 
6
-This release provides a deeper integration with Azure (DevOps Git hosts 
7
-and ACR) and allows configuring how `fluxctl` finds `fluxd` (useful for 
6
+This release provides a deeper integration with Azure (DevOps Git hosts
7
+and ACR) and allows configuring how `fluxctl` finds `fluxd` (useful for
8 8
 clusters with multiple fluxd installations).
9 9
 
10 10
 ### Improvements
@@ -19,7 +19,7 @@ clusters with multiple fluxd installations).
19 19
 
20 20
 ### Thanks
21 21
 
22
-Lots of thanks to @alanjcastonguay, @hiddeco, and @sarath-p for their 
22
+Lots of thanks to @alanjcastonguay, @hiddeco, and @sarath-p for their
23 23
 contributions to this release.
24 24
 
25 25
 [#1694]: https://github.com/weaveworks/flux/pull/1694
@@ -324,7 +324,7 @@ because it introduces a new flag, `--listen-metrics`.
324 324
 ### Improvements
325 325
 
326 326
 - Prometheus metrics can be exposed on a port different from that of
327
-  the flux API, using the flag `--listen-metrics`
327
+  the Flux API, using the flag `--listen-metrics`
328 328
   [weaveworks/flux#1325](https://github.com/weaveworks/flux/pull/1325)
329 329
 
330 330
 ### Thanks
@@ -555,7 +555,7 @@ reindent blocks the first time it changes a file.
555 555
 
556 556
 ### Improvements
557 557
 
558
-- Let the flux daemon operate without a git repo, and report cluster resources as read-only when there is no corresponding manifest [weaveworks/flux#962](https://github.com/weaveworks/flux/pull/962)
558
+- Let the Flux daemon operate without a git repo, and report cluster resources as read-only when there is no corresponding manifest [weaveworks/flux#962](https://github.com/weaveworks/flux/pull/962)
559 559
 - Reinstate command-line arg for setting the git polling interval `--git-poll-interval` [weaveworks/flux#1030](https://github.com/weaveworks/flux/pull/1030)
560 560
 - Add `--git-ci-skip` (and for more fine control, `--git-ci-skip-message`) for customising flux's commit messages such that CI systems ignore the commits [weaveworks/flux#1011](https://github.com/weaveworks/flux/pull/1011)
561 561
 - Log the daemon version on startup [weaveworks/flux#1017](https://github.com/weaveworks/flux/pull/1017)
@@ -661,7 +661,7 @@ registry.
661 661
 
662 662
 - Flux daemon can be configured to populate the git commit author with
663 663
   the name of the requesting user
664
-- When multiple flux daemons share the same configuration repository,
664
+- When multiple Flux daemons share the same configuration repository,
665 665
   each fluxd only sends Slack notifications for commits that affect
666 666
   its branch/path
667 667
 - When a resource is locked the invoking user is recorded, along with
@@ -676,7 +676,7 @@ registry.
676 676
 
677 677
 ## 1.0.0 (2017-08-22)
678 678
 
679
-This release introduces significant changes to the way flux works:
679
+This release introduces significant changes to the way Flux works:
680 680
 
681 681
 - The git repository is now the system of record for your cluster
682 682
   state. Flux continually works to synchronise your cluster with the
@@ -723,7 +723,7 @@ More informative and helpful UI.
723 723
 
724 724
 -   Slack notifications are tidier
725 725
 -   Support for releasing to >1 service at a time
726
--   Better behaviour when flux deploys itself
726
+-   Better behaviour when Flux deploys itself
727 727
 -   More help given for commonly encountered errors
728 728
 -   Filter out Kubernetes add-ons from consideration
729 729
 -   More consistent Prometheus metric labeling

+ 7
- 7
chart/flux/CHANGELOG.md View File

@@ -39,9 +39,9 @@
39 39
 
40 40
 ## 0.6.0 (2019-01-14)
41 41
 
42
-**Note** To fix the connectivity problems between Flux and memcached we've changed the 
43
-memcached service from headless to ClusterIP. This change will make the Helm upgrade fail 
44
-with `ClusterIP field is immutable`. 
42
+**Note** To fix the connectivity problems between Flux and memcached we've changed the
43
+memcached service from headless to ClusterIP. This change will make the Helm upgrade fail
44
+with `ClusterIP field is immutable`.
45 45
 
46 46
 Before upgrading to 0.6.0 you have to delete the memcached headless service:
47 47
 
@@ -61,16 +61,16 @@ kubectl -n flux delete svc flux-memcached
61 61
    [weaveworks/flux#1626](https://github.com/weaveworks/flux/pull/1626)
62 62
     - Rectify error where `resources` are not `None` by default in `chart/flux/values.yaml`
63 63
     - Add more fields that are actually in `chart/flux/values.yaml`
64
-    - Separate `replicaCount` into a flux one and `helmOperator.replicaCount` one
64
+    - Separate `replicaCount` into a Flux one and `helmOperator.replicaCount` one
65 65
   - Only create the `flux-helm-tls-ca-config` file if `.Values.helmOperator.tls.caContent` exists.
66
-    Useful when doing flux upgrades but do not happen to know or want to specify
66
+    Useful when doing Flux upgrades but do not happen to know or want to specify
67 67
     the `caContent` in `values.yaml`. Otherwise, the existing caContent will be overriden with an
68 68
     empty value.
69 69
     [weaveworks/flux#1649](https://github.com/weaveworks/flux/pull/1649)
70 70
   - Add Flux AWS ECR flags
71 71
     [weaveworks/flux#1655](https://github.com/weaveworks/flux/pull/1655)
72 72
 
73
-   
73
+
74 74
 ## 0.5.2 (2018-12-20)
75 75
 
76 76
 ### Improvements
@@ -123,7 +123,7 @@ Thanks to @davidkarlsen, @stephenmoloney, @batpok, @squaremo,
123 123
 ### Improvements
124 124
 
125 125
  - Updated Helm operator to `v0.4.0`
126
-   [weaveworks/flux#1487](https://github.com/weaveworks/flux/pull/1487)    
126
+   [weaveworks/flux#1487](https://github.com/weaveworks/flux/pull/1487)
127 127
  - Added `--tiller-tls-hostname` Helm operator config flag to the chart
128 128
    [weaveworks/flux#1484](https://github.com/weaveworks/flux/pull/1484)
129 129
  - Include `valueFileSecrets` property in `helm-operator-crd.yaml`

+ 15
- 15
chart/flux/README.md View File

@@ -92,9 +92,9 @@ weaveworks/flux
92 92
 
93 93
 #### To install Flux with a private git host:
94 94
 
95
-When using a private git host, setting the `ssh.known_hosts` variable 
96
-is required for enabling successful key matches because `StrictHostKeyChecking` 
97
-is enabled during flux git daemon operations.
95
+When using a private git host, setting the `ssh.known_hosts` variable
96
+is required for enabling successful key matches because `StrictHostKeyChecking`
97
+is enabled during Flux git daemon operations.
98 98
 
99 99
 By setting the `ssh.known_hosts` variable, a configmap will be created
100 100
 called `flux-ssh-config` which in turn will be mounted into a volume named
@@ -110,7 +110,7 @@ To prevent a potential man-in-the-middle attack, one should
110 110
 verify the ssh keys acquired through the `ssh-keyscan` match expectations
111 111
 using an alternate mechanism.
112 112
 
113
-* Start flux and flux helm operator:
113
+* Start Flux and Flux helm operator:
114 114
 
115 115
   - Using a string for setting `known_hosts`
116 116
 
@@ -185,17 +185,17 @@ The following tables lists the configurable parameters of the Weave Flux chart a
185 185
 | ------------------------------- | ------------------------------------------ | ---------------------------------------------------------- |
186 186
 | `image.repository` | Image repository | `quay.io/weaveworks/flux`
187 187
 | `image.tag` | Image tag | `<VERSION>`
188
-| `replicaCount` | Number of flux pods to deploy, more than one is not desirable. | `1`
188
+| `replicaCount` | Number of Flux pods to deploy, more than one is not desirable. | `1`
189 189
 | `image.pullPolicy` | Image pull policy | `IfNotPresent`
190 190
 | `image.pullSecret` | Image pull secret | `None`
191
-| `resources.requests.cpu` | CPU resource requests for the flux deployment | `50m`
192
-| `resources.requests.memory` | Memory resource requests for the flux deployment | `64Mi`
193
-| `resources.limits` | CPU/memory resource limits for the flux deployment | `None`
194
-| `nodeSelector` | Node Selector properties for the flux deployment | `{}`
195
-| `tolerations` | Tolerations properties for the flux deployment | `[]`
196
-| `affinity` | Affinity properties for the flux deployment | `{}`
191
+| `resources.requests.cpu` | CPU resource requests for the Flux deployment | `50m`
192
+| `resources.requests.memory` | Memory resource requests for the Flux deployment | `64Mi`
193
+| `resources.limits` | CPU/memory resource limits for the Flux deployment | `None`
194
+| `nodeSelector` | Node Selector properties for the Flux deployment | `{}`
195
+| `tolerations` | Tolerations properties for the Flux deployment | `[]`
196
+| `affinity` | Affinity properties for the Flux deployment | `{}`
197 197
 | `token` | Weave Cloud service token | `None`
198
-| `extraEnvs` | Extra environment variables for the flux pod(s) | `[]`
198
+| `extraEnvs` | Extra environment variables for the Flux pod(s) | `[]`
199 199
 | `rbac.create` | If `true`, create and use RBAC resources | `true`
200 200
 | `serviceAccount.create` | If `true`, create a new service account | `true`
201 201
 | `serviceAccount.name` | Service account to be used | `flux`
@@ -234,7 +234,7 @@ The following tables lists the configurable parameters of the Weave Flux chart a
234 234
 | `memcached.repository` | Image repository | `memcached`
235 235
 | `memcached.resources` | CPU/memory resource requests/limits for memcached | `None`
236 236
 | `helmOperator.create` | If `true`, install the Helm operator | `false`
237
-| `helmOperator.createCRD` | Create the `v1beta1` and `v1alpha2` flux CRDs. Dependent on `helmOperator.create=true` | `true`
237
+| `helmOperator.createCRD` | Create the `v1beta1` and `v1alpha2` Flux CRDs. Dependent on `helmOperator.create=true` | `true`
238 238
 | `helmOperator.repository` | Helm operator image repository | `quay.io/weaveworks/helm-operator`
239 239
 | `helmOperator.tag` | Helm operator image tag | `<VERSION>`
240 240
 | `helmOperator.replicaCount` | Number of helm operator pods to deploy, more than one is not desirable. | `1`
@@ -266,8 +266,8 @@ The following tables lists the configurable parameters of the Weave Flux chart a
266 266
 | `helmOperator.nodeSelector` | Node Selector properties for the helmOperator deployment | `{}`
267 267
 | `helmOperator.tolerations` | Tolerations properties for the helmOperator deployment | `[]`
268 268
 | `helmOperator.affinity` | Affinity properties for the helmOperator deployment | `{}`
269
-| `kube.config` | Override for kubectl default config in the flux pod(s). | [See values.yaml](https://github.com/weaveworks/flux/blob/master/chart/flux/values.yaml#L151-L165)
270
-| `prometheus.enabled` | If enbaled, adds prometheus annotations to flux and helmOperator pod(s) | `false`
269
+| `kube.config` | Override for kubectl default config in the Flux pod(s). | [See values.yaml](https://github.com/weaveworks/flux/blob/master/chart/flux/values.yaml#L151-L165)
270
+| `prometheus.enabled` | If enbaled, adds prometheus annotations to Flux and helmOperator pod(s) | `false`
271 271
 
272 272
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example:
273 273
 

+ 1
- 1
cluster/kubernetes/resource/fluxhelmrelease.go View File

@@ -8,7 +8,7 @@ import (
8 8
 	"github.com/weaveworks/flux/resource"
9 9
 )
10 10
 
11
-// ReleaseContainerName is the name used when flux interprets a
11
+// ReleaseContainerName is the name used when Flux interprets a
12 12
 // FluxHelmRelease as having a container with an image, by virtue of
13 13
 // having a `values` stanza with an image field:
14 14
 //

+ 1
- 1
cmd/fluxctl/root_cmd.go View File

@@ -72,7 +72,7 @@ func (opts *rootOpts) Command() *cobra.Command {
72 72
 	cmd.PersistentFlags().StringToStringVar(&opts.Labels, "k8s-fwd-labels", map[string]string{"app": "flux"},
73 73
 		fmt.Sprintf("Labels used to select the fluxd pod a port forward should be created for. You can also set the environment variable %s", envVariableLabels))
74 74
 	cmd.PersistentFlags().StringVarP(&opts.URL, "url", "u", "",
75
-		fmt.Sprintf("Base URL of the flux API (defaults to %q if a token is provided); you can also set the environment variable %s", defaultURLGivenToken, envVariableURL))
75
+		fmt.Sprintf("Base URL of the Flux API (defaults to %q if a token is provided); you can also set the environment variable %s", defaultURLGivenToken, envVariableURL))
76 76
 	cmd.PersistentFlags().StringVarP(&opts.Token, "token", "t", "",
77 77
 		fmt.Sprintf("Weave Cloud authentication token; you can also set the environment variable %s or %s", envVariableCloudToken, envVariableToken))
78 78
 

+ 1
- 1
git/errors.go View File

@@ -48,7 +48,7 @@ cross-check with the fingerprint given by
48 48
 func ErrUpstreamNotWritable(url string, actual error) error {
49 49
 	help := `Could not write to upstream repository
50 50
 
51
-To keep track of synchronisation, the flux daemon must be able to
51
+To keep track of synchronisation, the Flux daemon must be able to
52 52
 write to the upstream git repository.
53 53
 `
54 54
 	if strings.HasPrefix(url, "http://") ||

+ 1
- 1
http/client/client.go View File

@@ -178,7 +178,7 @@ func (c *Client) methodWithResp(ctx context.Context, method string, dest interfa
178 178
 	return nil
179 179
 }
180 180
 
181
-// get executes a get request against the flux server. it unmarshals the response into dest.
181
+// get executes a get request against the Flux server. it unmarshals the response into dest.
182 182
 func (c *Client) Get(ctx context.Context, dest interface{}, route string, queryParams ...string) error {
183 183
 	u, err := transport.MakeURL(c.endpoint, c.router, route, queryParams...)
184 184
 	if err != nil {

+ 1
- 1
internal_docs/releasing.md View File

@@ -92,7 +92,7 @@ Get the PR reviewed, and merge it.
92 92
 
93 93
 6. [Create a release in GitHub](https://github.com/weaveworks/flux/releases/new)
94 94
 
95
-Use a tag name as explained above; semver for the flux daemon, `helm-`
95
+Use a tag name as explained above; semver for the Flux daemon, `helm-`
96 96
 then the semver for the Helm operator.
97 97
 
98 98
 Copy and paste the changelog entry. You may need to remove newlines

+ 1
- 1
registry/cache/registry.go View File

@@ -19,7 +19,7 @@ var (
19 19
 
20 20
 It takes time to initially cache all the images. Please wait.
21 21
 
22
-If you have waited for a long time, check the flux logs. Potential
22
+If you have waited for a long time, check the Flux logs. Potential
23 23
 reasons for the error are: no internet, no cache, error with the remote
24 24
 repository.
25 25
 `,

+ 6
- 6
remote/errors.go View File

@@ -7,7 +7,7 @@ import (
7 7
 func UnavailableError(err error) error {
8 8
 	return &fluxerr.Error{
9 9
 		Type: fluxerr.User,
10
-		Help: `Cannot contact flux daemon
10
+		Help: `Cannot contact Flux daemon
11 11
 
12 12
 To service this request, we need to ask the agent running in your
13 13
 cluster (fluxd) for some information. But we can't connect to it at
@@ -16,7 +16,7 @@ present.
16 16
 This may be because it's not running at all, is temporarily
17 17
 disconnected or has been firewalled.
18 18
 
19
-If you are sure flux is running, you can simply wait a few seconds
19
+If you are sure Flux is running, you can simply wait a few seconds
20 20
 and try the operation again.
21 21
 
22 22
 Otherwise, please consult the installation instructions in our
@@ -36,7 +36,7 @@ If you are still stuck, please log an issue:
36 36
 func UpgradeNeededError(err error) error {
37 37
 	return &fluxerr.Error{
38 38
 		Type: fluxerr.User,
39
-		Help: `Your flux daemon needs to be upgraded
39
+		Help: `Your Flux daemon needs to be upgraded
40 40
 
41 41
     ` + err.Error() + `
42 42
 
@@ -44,7 +44,7 @@ To service this request, we need to ask the agent running in your
44 44
 cluster (fluxd) to perform an operation on our behalf, but the
45 45
 version you have running is too old to understand the request.
46 46
 
47
-Please install the latest version of flux and try again.
47
+Please install the latest version of Flux and try again.
48 48
 
49 49
 `,
50 50
 		Err: err,
@@ -59,7 +59,7 @@ func UnsupportedResourceKind(err error) error {
59 59
 The version of the agent running in your cluster (fluxd) can release updates to
60 60
 the following kinds of pod controller: Deployments, DaemonSets, StatefulSets
61 61
 and CronJobs. When new kinds are added to Kubernetes, we try to support them as
62
-quickly as possible - check here to see if a new version of flux is available:
62
+quickly as possible - check here to see if a new version of Flux is available:
63 63
 
64 64
 	https://github.com/weaveworks/flux/releases
65 65
 
@@ -74,7 +74,7 @@ that matches your agent.
74 74
 func ClusterError(err error) error {
75 75
 	return &fluxerr.Error{
76 76
 		Type: fluxerr.User,
77
-		Help: `Error from flux daemon
77
+		Help: `Error from Flux daemon
78 78
 
79 79
 The Flux daemon (fluxd) reported this error:
80 80
 

+ 1
- 1
site/annotations-tutorial.md View File

@@ -83,7 +83,7 @@ make sure you replace `YOURUSER` with your GitHub username in the command
83 83
 below:
84 84
 
85 85
 ```sh
86
-helm upgrade -i flux \
86
+helm upgrade -i Flux \
87 87
 --set helmOperator.create=true \
88 88
 --set helmOperator.createCRD=false \
89 89
 --set git.url=git@github.com:YOURUSER/flux-get-started \

+ 1
- 1
site/daemon.md View File

@@ -5,7 +5,7 @@ menu_order: 90
5 5
 
6 6
 # Summary
7 7
 
8
-Flux daemon (fluxd, aka flux agent) allows automation of application deployments and version control of cluster configuration.
8
+Flux daemon (fluxd, aka Flux agent) allows automation of application deployments and version control of cluster configuration.
9 9
 Version controlling of cluster manifests provides reproducibility and a historical trail of events.
10 10
 
11 11
 ## Flux daemon responsibilities

+ 1
- 1
site/faq.md View File

@@ -333,7 +333,7 @@ places (the `volume`, `volumeMount`, and `env` entries).
333 333
 The easiest way to create a suitable "kubeconfig" will be to adapt the
334 334
 [file that is baked into the image](../docker/kubeconfig). Save that
335 335
 locally as `my-kubeconfig`, edit it to change the default namespace,
336
-then create the configmap, in the same namespace you run flux in, with
336
+then create the configmap, in the same namespace you run Flux in, with
337 337
 something like:
338 338
 
339 339
     kubectl create configmap flux-kubeconfig --from-file=config=./my-kubeconfig

+ 5
- 5
site/fluxctl.md View File

@@ -11,7 +11,7 @@ menu_order: 40
11 11
 - [Connecting fluxctl to the daemon](#connecting-fluxctl-to-the-daemon)
12 12
   * [Flux API service](#flux-api-service)
13 13
   * [Add an SSH deploy key to the repository](#add-an-ssh-deploy-key-to-the-repository)
14
-    + [1. Allow flux to generate a key for you](#1-allow-flux-to-generate-a-key-for-you)
14
+    + [1. Allow Flux to generate a key for you](#1-allow-flux-to-generate-a-key-for-you)
15 15
     + [2. Specify a key to use](#2-specify-a-key-to-use)
16 16
 - [Controllers](#controllers)
17 17
   * [What is a Controller?](#what-is-a-controller)
@@ -115,7 +115,7 @@ fluxctl list-controllers --all-namespaces
115 115
 Flux connects to the repository using an SSH key. You have two
116 116
 options:
117 117
 
118
-### 1. Allow flux to generate a key for you
118
+### 1. Allow Flux to generate a key for you
119 119
 
120 120
 If you don't specify a key to use, Flux will create one for you. Obtain
121 121
 the public key through fluxctl:
@@ -231,7 +231,7 @@ Flags:
231 231
       --k8s-fwd-labels stringToString   Labels used to select the fluxd pod a port forward should be created for. You can also set the environment variable FLUX_FORWARD_LABELS (default [app=flux])
232 232
       --k8s-fwd-ns string               Namespace in which fluxd is running, for creating a port forward to access the API. No port forward will be created if a URL or token is given. You can also set the environment variable FLUX_FORWARD_NAMESPACE (default "default")
233 233
   -t, --token string                    Weave Cloud authentication token; you can also set the environment variable WEAVE_CLOUD_TOKEN or FLUX_SERVICE_TOKEN
234
-  -u, --url string                      Base URL of the flux API (defaults to "https://cloud.weave.works/api/flux" if a token is provided); you can also set the environment variable FLUX_URL
234
+  -u, --url string                      Base URL of the Flux API (defaults to "https://cloud.weave.works/api/flux" if a token is provided); you can also set the environment variable FLUX_URL
235 235
 
236 236
 Use "fluxctl [command] --help" for more information about a command.
237 237
 ```
@@ -455,7 +455,7 @@ quay.io/weaveworks/helloworld:master-9a16ff945b9e
455 455
 Indicates that the `helloworld` image was built against master
456 456
 commit `9a16ff945b9e`.
457 457
 
458
-When automation is turned on flux will, by default, use whatever
458
+When automation is turned on Flux will, by default, use whatever
459 459
 is the latest image on a given repository. If you want to only
460 460
 auto-update your image against a certain subset of tags then you
461 461
 can do that using tag filtering.
@@ -525,7 +525,7 @@ or only release images that have a stable semantic version tag (X.Y.Z):
525 525
 fluxctl policy --controller=default:deployment/helloworld --tag-all='semver:*'
526 526
 ```
527 527
 
528
-Using a semver filter will also affect how flux sorts images, so
528
+Using a semver filter will also affect how Flux sorts images, so
529 529
 that the higher versions will be considered newer.
530 530
 
531 531
 ## Regexp

+ 7
- 7
site/get-started-developing.md View File

@@ -1,6 +1,6 @@
1 1
 # Get Started Developing Flux
2 2
 
3
-This tutorial is going to walk you through one possible workflow for making a small (actually, tiny) change to flux and building and testing that change locally.
3
+This tutorial is going to walk you through one possible workflow for making a small (actually, tiny) change to Flux and building and testing that change locally.
4 4
 
5 5
 > ### TL;DR
6 6
 >
@@ -17,7 +17,7 @@ This tutorial is going to walk you through one possible workflow for making a sm
17 17
 >    1. make a change to the code
18 18
 >    1. see your code changes have been deployed
19 19
 >    1. repeat
20
-> 1. Use `helm` and `skaffold` together to deploy changes to the flux helm chart.
20
+> 1. Use `helm` and `skaffold` together to deploy changes to the Flux helm chart.
21 21
 >    1. `make`
22 22
 >    1. make a change to the code
23 23
 >    1. see your code changes have been deployed
@@ -64,7 +64,7 @@ Now that we know everything is working with `flux-getting-started`, we're going
64 64
     eval $(minikube docker-env)
65 65
     ```
66 66
 
67
-    Now, be warned. These are local variables.  This means that if you run this `eval` in one terminal and then switch to another for later when we build the flux project, you're gonna hit some issues.  For one, you'll know it isn't working because Kubernetes will tell you that it can't pull the image when you run `kubectl get pods`:
67
+    Now, be warned. These are local variables.  This means that if you run this `eval` in one terminal and then switch to another for later when we build the Flux project, you're gonna hit some issues.  For one, you'll know it isn't working because Kubernetes will tell you that it can't pull the image when you run `kubectl get pods`:
68 68
 
69 69
     ```
70 70
     NAME                        READY   STATUS         RESTARTS   AGE
@@ -77,7 +77,7 @@ Now that we know everything is working with `flux-getting-started`, we're going
77 77
 
78 78
 1. Clone `git@github.com:<YOUR-GITHUB-USERNAME>/flux.git` replacing `<YOUR-GITHUB-USERNAME>` with your GitHub username.
79 79
 
80
-    In the same terminal you ran `eval $(minikube docker-env)`, run `dep ensure` followed by `make` from the root directory of the flux repo.  You'll see docker's usual output as it builds the image layers.  Once it's done, you should see something like this in the middle of the output:
80
+    In the same terminal you ran `eval $(minikube docker-env)`, run `dep ensure` followed by `make` from the root directory of the Flux repo.  You'll see docker's usual output as it builds the image layers.  Once it's done, you should see something like this in the middle of the output:
81 81
     ```
82 82
     Successfully built 606610e0f4ef
83 83
     Successfully tagged quay.io/weaveworks/flux:latest
@@ -118,7 +118,7 @@ Now that we know everything is working with `flux-getting-started`, we're going
118 118
     secret/flux-git-deploy configured
119 119
     ```
120 120
 
121
-    Congrats you just deployed your local flux to your default namespace.  Check that everything is running:
121
+    Congrats you just deployed your local Flux to your default namespace.  Check that everything is running:
122 122
 
123 123
     ```sh
124 124
     kubectl get pods --selector=name=flux
@@ -132,7 +132,7 @@ Now that we know everything is working with `flux-getting-started`, we're going
132 132
 
133 133
     If (instead) you see that Ready is showing `0/1` and/or the status is `ErrImagePull` double back on the instructions and make sure you did everything correctly and in order.
134 134
 
135
-1. Pull the logs for your "fresh off of master" copy of flux that you just deployed locally to Minikube:
135
+1. Pull the logs for your "fresh off of master" copy of Flux that you just deployed locally to Minikube:
136 136
     ```sh
137 137
     kubectl logs --selector=name=flux
138 138
     ```
@@ -178,4 +178,4 @@ Now that we know everything is working with `flux-getting-started`, we're going
178 178
 
179 179
 ## Congratulations!
180 180
 
181
-You have now modified Flux and deployed that change locally.  From here on out, you simply need to run `make` after you save your changes and wait a few seconds for your new pod to be deployed to minikube.  Keep in mind, that (as in the situation where you run `make` without saving any changes) if the docker image you pointed to in the Kubernetes deployment for flux is not Successfully tagged, `freshpod` won't have anything new to deploy.  Other than that, you should be good to go!
181
+You have now modified Flux and deployed that change locally.  From here on out, you simply need to run `make` after you save your changes and wait a few seconds for your new pod to be deployed to minikube.  Keep in mind, that (as in the situation where you run `make` without saving any changes) if the docker image you pointed to in the Kubernetes deployment for Flux is not Successfully tagged, `freshpod` won't have anything new to deploy.  Other than that, you should be good to go!

+ 2
- 2
site/helm-operator.md View File

@@ -166,7 +166,7 @@ helm --tls --tls-verify \
166 166
   ls
167 167
 ```
168 168
 
169
-### deploy weave flux helm-operator
169
+### deploy weave Flux helm-operator
170 170
 
171 171
 First create a new Kubernetes TLS secret for the client certs;
172 172
 
@@ -225,7 +225,7 @@ metadata:
225 225
 
226 226
 ## Installing Weave Flux helm-operator for Weave Cloud
227 227
 
228
-In order to use the Helm operator with Weave Cloud you have to apply the `HelmRelease` CRD definition and the operator 
228
+In order to use the Helm operator with Weave Cloud you have to apply the `HelmRelease` CRD definition and the operator
229 229
 deployment in the `weave` namespace:
230 230
 
231 231
 ```bash

+ 2
- 2
site/helm-upgrading-to-beta.md View File

@@ -25,7 +25,7 @@ Here are some things to know:
25 25
 
26 26
 The safest way to upgrade is to avoid deletions and fights by stopping
27 27
 the old operator. Replacing it with the new one (e.g., by changing the
28
-deployment, or re-releasing the flux chart with the new version) will
28
+deployment, or re-releasing the Flux chart with the new version) will
29 29
 have that effect.
30 30
 
31 31
 Once the old operator is not running, it is safe to deploy the new
@@ -35,7 +35,7 @@ since the new operator will ignore them.
35 35
 
36 36
 ## Upgrading the operator deployment
37 37
 
38
-### Using the flux chart
38
+### Using the Flux chart
39 39
 
40 40
 The chart (from v0.5.0, or from this git repo) provides the
41 41
 correct arguments to the operator; to upgrade, do

+ 1
- 1
site/monitoring.md View File

@@ -3,7 +3,7 @@ title: Monitoring Weave Flux
3 3
 menu_order: 70
4 4
 ---
5 5
 
6
-The flux daemon exposes `/metrics` endpoints which can be scraped for
6
+The Flux daemon exposes `/metrics` endpoints which can be scraped for
7 7
 monitoring data in Prometheus format; exact metric names and help are
8 8
 available from the endpoints themselves.
9 9
 

+ 1
- 1
site/standalone-setup.md View File

@@ -107,7 +107,7 @@ by removing the deploy key.
107 107
 
108 108
 If you're using your own git host -- e.g., your own installation of
109 109
 gitlab, or bitbucket server -- you will need to add its host key to
110
-`~/.ssh/known_hosts` in the flux daemon container.
110
+`~/.ssh/known_hosts` in the Flux daemon container.
111 111
 
112 112
 First, run a check that you can clone the repo. The following assumes
113 113
 that your git server's hostname (e.g., `githost`) is in `$GITHOST` and

+ 1
- 1
site/troubleshooting.md View File

@@ -31,7 +31,7 @@ This is also documented in the
31 31
 
32 32
 ### `fluxctl` returns a 500 Internal Server Error
33 33
 
34
-This usually indicates there's a bug in the flux daemon somewhere -- in which case please [tell us about it](https://github.com/weaveworks/flux/issues/new)!
34
+This usually indicates there's a bug in the Flux daemon somewhere -- in which case please [tell us about it](https://github.com/weaveworks/flux/issues/new)!
35 35
 
36 36
 ### Flux answers everything with `git repo is not configured`
37 37
 

+ 4
- 4
site/upgrading-to-1.0.md View File

@@ -80,7 +80,7 @@ git (and GitHub) workflows to manage your cluster.
80 80
 In summary, you will need to:
81 81
 
82 82
  1. Remove the old Flux resources from your cluster
83
- 2. Delete any deployment keys 
83
+ 2. Delete any deployment keys
84 84
  3. Run the new Flux resources
85 85
  4. Install a new deploy key
86 86
 
@@ -151,7 +151,7 @@ key used by Flux with
151 151
 > other words, it tries to keep the cluster running whatever is
152 152
 > represented in the repo. (Though it doesn’t delete things, yet.)
153 153
 
154
-To run the new Flux with Weave Cloud: 
154
+To run the new Flux with Weave Cloud:
155 155
 
156 156
  * Go to your instance settings (the cog icon) and click the “Config”
157 157
    then “Deploy” menu items
@@ -185,8 +185,8 @@ Before making any changes, get the config so that it can be consulted later:
185 185
 > *Important! If you have Flux resources committed to git*
186 186
 >
187 187
 > The first thing to do here is to remove any manifests for running
188
-> flux you have stored in git, before deleting them in the cluster
189
-> (below). If you don’t remove these, running the new flux daemon will
188
+> Flux you have stored in git, before deleting them in the cluster
189
+> (below). If you don’t remove these, running the new Flux daemon will
190 190
 > restore the old configuration.
191 191
 
192 192
 You can delete the Flux resources by referring to the manifest files

+ 4
- 4
test/bin/test-flux View File

@@ -21,14 +21,14 @@ minikube delete --profile "$PROFILE" || true
21 21
 minikube start --profile "$PROFILE" --keep-context
22 22
 MINIKUBE_IP=$(minikube --profile "$PROFILE" ip)
23 23
 
24
-# Copy the latest flux image into the minikube VM
24
+# Copy the latest Flux image into the minikube VM
25 25
 docker save quay.io/weaveworks/flux:latest | (eval $(minikube --profile "$PROFILE" docker-env) && docker load)
26 26
 
27 27
 # Create a central git repo inside the minikube VM and get the host key for ssh access
28 28
 minikube --profile "$PROFILE" ssh -- git init --bare /home/docker/flux.git
29 29
 ssh-keyscan $MINIKUBE_IP > "$KNOWN_HOSTS"
30 30
 
31
-# Deploy flux in kube-system namespace, supplying it with the SSH keys it needs to access & authenticate the config repo
31
+# Deploy Flux in kube-system namespace, supplying it with the SSH keys it needs to access & authenticate the config repo
32 32
 kubectl --context "$PROFILE" -n kube-system create secret generic flux-git-deploy --from-file=identity="$SSH_PRIVATE_KEY"
33 33
 kubectl --context "$PROFILE" -n kube-system create configmap ssh-known-hosts --from-file=known_hosts="$KNOWN_HOSTS"
34 34
 sed -e "s/MINIKUBE_IP/$MINIKUBE_IP/" "$BASEDIR/flux-deploy-all.yaml" | kubectl --context "$PROFILE" -n kube-system apply -f-
@@ -113,7 +113,7 @@ git -C "$CONFIG_REPO" push -u origin master
113 113
 # Wait two minutes for flux-sync tag to point to local HEAD
114 114
 wait_for_sync 120
115 115
 
116
-# Examine services via flux API an assert container versions are correct
116
+# Examine services via Flux API an assert container versions are correct
117 117
 assert_controller_container default default:deployment/helloworld helloworld quay.io/weaveworks/helloworld:master-a000001
118 118
 assert_controller_container default default:deployment/helloworld sidecar quay.io/weaveworks/sidecar:master-a000001
119 119
 
@@ -123,7 +123,7 @@ fluxctl --url http://$(minikube -p flux-test ip):30080/api/flux automate --contr
123 123
 # Wait two minutes for two (automation and release) commits to appear
124 124
 wait_for_upstream_commits 120 2
125 125
 
126
-# Examine services via flux API an assert container versions are updated
126
+# Examine services via Flux API an assert container versions are updated
127 127
 assert_controller_container default default:deployment/helloworld helloworld quay.io/weaveworks/helloworld:master-9a16ff945b9e
128 128
 assert_controller_container default default:deployment/helloworld sidecar quay.io/weaveworks/sidecar:master-a000002
129 129
 

+ 1
- 1
test/flux-deploy-all.yaml View File

@@ -36,7 +36,7 @@ spec:
36 36
   selector:
37 37
     name: memcached
38 38
 ---
39
-# Expose flux to fluxctl
39
+# Expose Flux to fluxctl
40 40
 apiVersion: v1
41 41
 kind: Service
42 42
 metadata:

Loading…
Cancel
Save