Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@1995parham
1995parham committed Jul 31, 2024
1 parent 4686085 commit 4b8fd83
Showing 1 changed file with 27 additions and 28 deletions.
55 changes: 27 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#
#

<h1 align="center"> <a href="https://argo-cd.readthedocs.io/en/stable/">ArgoCD</a> Complementary Operator </h1>
<h6 align="center">Manage your ArgoCD users and project with ease and some labels!</h6>
Expand Down Expand Up @@ -38,9 +38,9 @@ spec:
### Development
* `make generate` update the generated code for that resource type.
* `make manifests` Generating CRD manifests.
* `make test` Run tests.
- `make generate` update the generated code for that resource type.
- `make manifests` Generating CRD manifests.
- `make test` Run tests.

### Build

Expand All @@ -50,38 +50,37 @@ Export your image name:
export IMG=ghcr.io/your-repo-path/image-name:latest
```

* `make build` builds golang app locally.
* `make docker-build` build docker image locally.
* `make docker-push` push container image to registry.
- `make build` builds Golang app locally.
- `make docker-build` build docker image locally.
- `make docker-push` push container image to registry.

### Run, Deploy
* `make run` run app locally
* `make deploy` deploy to k8s.

### Clean up
- `make run` run app locally
- `make deploy` deploy to k8s.

* `make undeploy` delete resouces in k8s.
### Clean up

- `make undeploy` delete resouces in k8s.

## Metrics

| Metric | Notes
|-----------------------------------------------------|------------------------------------
| controller_runtime_active_workers | Number of currently used workers per controller
| controller_runtime_max_concurrent_reconciles | Maximum number of concurrent reconciles per controller
| controller_runtime_reconcile_errors_total | Total number of reconciliation errors per controller
| controller_runtime_reconcile_time_seconds | Length of time per reconciliation per controller
| controller_runtime_reconcile_total | Total number of reconciliations per controller
| rest_client_request_latency_seconds | Request latency in seconds. Broken down by verb and URL.
| rest_client_requests_total | Number of HTTP requests, partitioned by status code, method, and host.
| workqueue_adds_total | Total number of adds handled by workqueue
| workqueue_depth | Current depth of workqueue
| workqueue_longest_running_processor_seconds | How many seconds has the longest running processor for workqueue been running.
| workqueue_queue_duration_seconds | How long in seconds an item stays in workqueue before being requested
| workqueue_retries_total | Total number of retries handled by workqueue
| workqueue_unfinished_work_seconds | How many seconds of work has been done that is in progress and hasn't been observed by work_duration. Large values indicate stuck threads. One can deduce the number of stuck threads by observing the rate at which this increases.
| workqueue_work_duration_seconds | How long in seconds processing an item from workqueue takes.

| Metric | Notes |
| :--------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `controller_runtime_active_workers` | Number of currently used workers per controller |
| `controller_runtime_max_concurrent_reconciles` | Maximum number of concurrent reconciles per controller |
| `controller_runtime_reconcile_errors_total` | Total number of reconciliation errors per controller |
| `controller_runtime_reconcile_time_seconds` | Length of time per reconciliation per controller |
| `controller_runtime_reconcile_total` | Total number of reconciliations per controller |
| `rest_client_request_latency_seconds` | Request latency in seconds. Broken down by verb and URL. |
| `rest_client_requests_total` | Number of HTTP requests, partitioned by status code, method, and host. |
| `workqueue_adds_total` | Total number of adds handled by workqueue |
| `workqueue_depth` | Current depth of workqueue |
| `workqueue_longest_running_processor_seconds` | How many seconds has the longest running processor for workqueue been running. |
| `workqueue_queue_duration_seconds` | How long in seconds an item stays in workqueue before being requested |
| `workqueue_retries_total` | Total number of retries handled by workqueue |
| `workqueue_unfinished_work_seconds` | How many seconds of work has been done that is in progress and hasn't been observed by `work_duration`. Large values indicate stuck threads. One can deduce the number of stuck threads by observing the rate at which this increases. |
| `workqueue_work_duration_seconds` | How long in seconds processing an item from workqueue takes. |

## Security

Expand Down

0 comments on commit 4b8fd83

Please sign in to comment.