Skip to content

Commit

Permalink
Merge branch 'master' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
crenshaw-dev committed Feb 20, 2023
2 parents ce85c11 + ba86be2 commit 53bb388
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ previous to the most recent one (`N-1`, e.g. `1.7`). With the release of

We regularly perform patch releases (e.g. `1.8.5` and `1.7.12`) for the
supported versions, which will contain fixes for security vulnerabilities and
important bugs. Prior releases might receive critical security fixes on a best
important bugs. Prior releases might receive critical security fixes on best
effort basis, however, it cannot be guaranteed that security fixes get
back-ported to these unsupported versions.

Expand All @@ -61,8 +61,8 @@ and disclosure with you. Sometimes, it might take a little longer for us to
react (e.g. out of office conditions), so please bear with us in these cases.

We will publish security advisories using the
[Git Hub Security Advisories](https://github.com/argoproj/argo-cd/security/advisories)
feature to keep our community well informed, and will credit you for your
[GitHub Security Advisories](https://github.com/argoproj/argo-cd/security/advisories)
feature to keep our community well-informed, and will credit you for your
findings (unless you prefer to stay anonymous, of course).

Please report vulnerabilities by e-mail to the following address:
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ git push origin <yourbranch>

First, make sure the failing build step succeeds on your machine. Remember the containerized build toolchain is available, too.

If the build is failing at the `Ensure Go modules synchronicity` step, you need to first download all Go dependent modules locally via `go mod download` and then run `go mod tidy` to make sure the dependent Go modules are tidied up. Finally commit and push your changes to `go.mod` and `go.sum` to your branch.
If the build is failing at the `Ensure Go modules synchronicity` step, you need to first download all Go dependent modules locally via `go mod download` and then run `go mod tidy` to make sure the dependent Go modules are tidied up. Finally, commit and push your changes to `go.mod` and `go.sum` to your branch.

If the build is failing at the `Build & cache Go code`, you need to make sure `make build-local` runs successfully on your local machine.

### Why does the codegen step fail?

If the codegen step fails with "Check nothing has changed...", chances are high that you did not run `make codegen`, or did not commit the changes it made. You should double check by running `make codegen` followed by `git status` in the local working copy of your branch. Commit any changes and push them to your GH branch to have the CI check it again.
If the codegen step fails with "Check nothing has changed...", chances are high that you did not run `make codegen`, or did not commit the changes it made. You should double-check by running `make codegen` followed by `git status` in the local working copy of your branch. Commit any changes and push them to your GH branch to have the CI check it again.

A second common case for this is, when you modified any of the auto generated assets, as these will be overwritten upon `make codegen`.

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/code-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ The current cadence of our meetings is weekly, every Thursday at 4:15pm UTC (8:1

If you want to discuss something, we kindly ask you to put your item on the
[agenda](https://docs.google.com/document/d/1xkoFkVviB70YBzSEa4bDnu-rUZ1sIFtwKKG1Uw8XsY8)
for one of the upcoming meetings so that we can plan in the time for discussing about it.
for one of the upcoming meetings so that we can plan in the time for discussing it.
2 changes: 1 addition & 1 deletion docs/developer-guide/contributors-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ cd argo-cd
make start-local ARGOCD_GPG_ENABLED=false
```

- Navigate to <localhost:4000> to the ArgoCD UI on browser
- Navigate to [localhost:4000](http://localhost:4000) in your browser to load the Argo CD UI
- It may take a few minutes for the UI to be responsive

!!! note
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ The `<version>` identifier needs to be specified **without** the `release-`
prefix, so just specify it as `v1.6.0-rc2` for example. The `<remote name>`
specifies the name of the remote used to push to the GitHub repository.

If you omit the `<release notes path>`, an editor will pop-up asking you to
enter the tag's annotation so you can paste the release notes, save, and exit.
If you omit the `<release notes path>`, an editor will pop up asking you to
enter the tag's annotation, so you can paste the release notes, save, and exit.
It will also take care of temporarily configuring the `core.commentChar` and
setting it back to its original state.

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/running-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Run Argo CD outside of Kubernetes

During development, it might be viable to run Argo CD outside of a Kubernetes cluster. This will greatly speed up development, as you don't have to constantly build, push and install new Argo CD Docker images with your latest changes.
During development, it might be viable to run Argo CD outside a Kubernetes cluster. This will greatly speed up development, as you don't have to constantly build, push and install new Argo CD Docker images with your latest changes.

You will still need a working Kubernetes cluster, as described in the [Toolchain Guide](toolchain-guide.md), where Argo CD will store all of its resources and configuration.

Expand Down Expand Up @@ -179,7 +179,7 @@ For your final tests, it might be necessary to build your own images and run the

### Create Docker account and login

You might need to create a account on [Docker Hub](https://hub.docker.com) if you don't have one already. Once you created your account, login from your development environment:
You might need to create an account on [Docker Hub](https://hub.docker.com) if you don't have one already. Once you created your account, login from your development environment:

```bash
docker login
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/site.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Developing And Testing

The web site is build using `mkdocs` and `mkdocs-material`.
The website is build using `mkdocs` and `mkdocs-material`.

To test:

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/test-e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Some effort has been made to balance test isolation with speed. Tests are isolat
* A random 5 character ID.
* A unique Git repository containing the `testdata` in `/tmp/argocd-e2e/${id}`.
* A namespace `argocd-e2e-ns-${id}`.
* An primary name for the app `argocd-e2e-${id}`.
* A primary name for the app `argocd-e2e-${id}`.

## Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/toolchain-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ you should edit your `~/.kube/config` and modify the `server` option to point to

### Using k3d

[k3d](https://github.com/rancher/k3d) is a lightweight wrapper to run [k3s](https://github.com/rancher/k3s), a minimal Kubernetes distribution, in docker. Because it's running in a docker container, you're dealing with docker's internal networking rules when using k3d. A typical Kubernetes cluster running on your local machine is part of the same network that you're on so you can access it using **kubectl**. However, a Kubernetes cluster running within a docker container (in this case, the one launched by make) cannot access 0.0.0.0 from inside the container itself, when 0.0.0.0 is a network resource outside the container itself (and/or the container's network). This is the cost of a fully self-contained, disposable Kubernetes cluster. The following steps should help with a successful `make verify-kube-connect` execution.
[k3d](https://github.com/rancher/k3d) is a lightweight wrapper to run [k3s](https://github.com/rancher/k3s), a minimal Kubernetes distribution, in docker. Because it's running in a docker container, you're dealing with docker's internal networking rules when using k3d. A typical Kubernetes cluster running on your local machine is part of the same network that you're on, so you can access it using **kubectl**. However, a Kubernetes cluster running within a docker container (in this case, the one launched by make) cannot access 0.0.0.0 from inside the container itself, when 0.0.0.0 is a network resource outside the container itself (and/or the container's network). This is the cost of a fully self-contained, disposable Kubernetes cluster. The following steps should help with a successful `make verify-kube-connect` execution.

1. Find your host IP by executing `ifconfig` on Mac/Linux and `ipconfig` on Windows. For most users, the following command works to find the IP address.

Expand Down Expand Up @@ -335,7 +335,7 @@ The next thing is to make sure that unit tests are running correctly on your sys

### Run end-to-end tests

The final step is running the End-to-End testsuite, which makes sure that your Kubernetes dependencies are working properly. This will involve starting all of the Argo CD components locally on your computer. The end-to-end tests consists of two parts: a server component, and a client component.
The final step is running the End-to-End testsuite, which makes sure that your Kubernetes dependencies are working properly. This will involve starting all the Argo CD components locally on your computer. The end-to-end tests consists of two parts: a server component, and a client component.

* First, start the End-to-End server: `make start-e2e-local`. This will spawn a number of processes and services on your system.
* When all components have started, run `make test-e2e-local` to run the end-to-end tests against your local services.
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/use-gitpod.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ for Argo CD development.
1. Fork [https://github.com/argoproj/argo-cd](https://github.com/argoproj/argo-cd) repository
1. Create Gitpod workspace by opening the following url in the browser:
`https://gitpod.io/#https://github.com/<USERNAME>/argo-cd` where
`<USERNAME>` is your Github username.
`<USERNAME>` is your GitHub username.

1. Once workspace is created you should see VSCode editor in the browser as well as workspace initialization
logs in the VSCode terminal. The initialization process downloads all backend and UI dependencies as well
Expand Down
8 changes: 4 additions & 4 deletions util/cache/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func AddCacheFlagsToCmd(cmd *cobra.Command, opts ...func(client *redis.Client))
sentinelAddresses := make([]string, 0)
sentinelMaster := ""
redisDB := 0
redisCACerticate := ""
redisCACertificate := ""
redisClientCertificate := ""
redisClientKey := ""
redisUseTLS := false
Expand All @@ -95,7 +95,7 @@ func AddCacheFlagsToCmd(cmd *cobra.Command, opts ...func(client *redis.Client))
cmd.Flags().StringVar(&redisClientCertificate, "redis-client-certificate", "", "Path to Redis client certificate (e.g. /etc/certs/redis/client.crt).")
cmd.Flags().StringVar(&redisClientKey, "redis-client-key", "", "Path to Redis client key (e.g. /etc/certs/redis/client.crt).")
cmd.Flags().BoolVar(&insecureRedis, "redis-insecure-skip-tls-verify", false, "Skip Redis server certificate validation.")
cmd.Flags().StringVar(&redisCACerticate, "redis-ca-certificate", "", "Path to Redis server CA certificate (e.g. /etc/certs/redis/ca.crt). If not specified, system trusted CAs will be used for server certificate validation.")
cmd.Flags().StringVar(&redisCACertificate, "redis-ca-certificate", "", "Path to Redis server CA certificate (e.g. /etc/certs/redis/ca.crt). If not specified, system trusted CAs will be used for server certificate validation.")
cmd.Flags().StringVar(&compressionStr, "redis-compress", env.StringFromEnv("REDIS_COMPRESSION", string(RedisCompressionNone)), "Enable compression for data sent to Redis with the required compression algorithm. (possible values: none, gzip)")
return func() (*Cache, error) {
var tlsConfig *tls.Config = nil
Expand All @@ -110,8 +110,8 @@ func AddCacheFlagsToCmd(cmd *cobra.Command, opts ...func(client *redis.Client))
}
if insecureRedis {
tlsConfig.InsecureSkipVerify = true
} else if redisCACerticate != "" {
redisCA, err := certutil.ParseTLSCertificatesFromPath(redisCACerticate)
} else if redisCACertificate != "" {
redisCA, err := certutil.ParseTLSCertificatesFromPath(redisCACertificate)
if err != nil {
return nil, err
}
Expand Down

0 comments on commit 53bb388

Please sign in to comment.