Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: replace caas-team with telekom due to repo transfer #251

Merged
merged 2 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .goreleaser-ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ builds:
- arm64
dockers:
- image_templates:
- "ghcr.io/caas-team/sparrow:{{ .Version }}"
- "ghcr.io/telekom/sparrow:{{ .Version }}"
- "mtr.devops.telekom.de/sparrow/sparrow:{{ .Version }}"
dockerfile: Dockerfile
build_flag_templates:
- --label=org.opencontainers.image.title={{ .ProjectName }}
- --label=org.opencontainers.image.description="This is a pre-release version. Do not use this in production!"
- --label=org.opencontainers.image.url=https://caas.telekom.de
- --label=org.opencontainers.image.source=https://github.com/caas-team/sparrow
- --label=org.opencontainers.image.source=https://github.com/telekom/sparrow
- --label=org.opencontainers.image.version={{ .Version }}
- --label=org.opencontainers.image.created={{ .Timestamp }}
- --label=org.opencontainers.image.revision={{ .FullCommit }}
Expand Down
12 changes: 6 additions & 6 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ builds:
- arm64
dockers:
- image_templates:
- "ghcr.io/caas-team/sparrow:latest"
- "ghcr.io/caas-team/sparrow:{{ .Tag }}"
- "ghcr.io/caas-team/sparrow:v{{ .Major }}.{{ .Minor }}"
- "ghcr.io/caas-team/sparrow:v{{ .Major }}"
- "ghcr.io/telekom/sparrow:latest"
- "ghcr.io/telekom/sparrow:{{ .Tag }}"
- "ghcr.io/telekom/sparrow:v{{ .Major }}.{{ .Minor }}"
- "ghcr.io/telekom/sparrow:v{{ .Major }}"
- "mtr.devops.telekom.de/sparrow/sparrow:latest"
- "mtr.devops.telekom.de/sparrow/sparrow:{{ .Tag }}"
- "mtr.devops.telekom.de/sparrow/sparrow:v{{ .Major }}.{{ .Minor }}"
Expand All @@ -24,7 +24,7 @@ dockers:
- --label=org.opencontainers.image.title={{ .ProjectName }}
- --label=org.opencontainers.image.description={{ .ProjectName }}
- --label=org.opencontainers.image.url=https://caas.telekom.de
- --label=org.opencontainers.image.source=https://github.com/caas-team/sparrow
- --label=org.opencontainers.image.source=https://github.com/telekom/sparrow
- --label=org.opencontainers.image.version={{ .Version }}
- --label=org.opencontainers.image.created={{ .Timestamp }}
- --label=org.opencontainers.image.revision={{ .FullCommit }}
Expand All @@ -33,7 +33,7 @@ nfpms:
- maintainer: CaaS <[email protected]>
description: |-
Monitoring tool to gather infrastructure network information
homepage: https://github.com/caas-team
homepage: https://github.com/telekom
license: Apache 2.0
formats:
- deb
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

<!-- markdownlint-disable MD033 -->
<p align="center">
<a href="/../../commits/" title="Last Commit"><img alt="Last Commit" src="https://img.shields.io/github/last-commit/caas-team/sparrow?style=flat"></a>
<a href="/../../issues" title="Open Issues"><img alt="Open Issues" src="https://img.shields.io/github/issues/caas-team/sparrow?style=flat"></a>
<a href="/../../commits/" title="Last Commit"><img alt="Last Commit" src="https://img.shields.io/github/last-commit/telekom/sparrow?style=flat"></a>
<a href="/../../issues" title="Open Issues"><img alt="Open Issues" src="https://img.shields.io/github/issues/telekom/sparrow?style=flat"></a>
<a href="./LICENSE" title="License"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"></a>
</p>
<!-- markdownlint-enable MD033 -->
Expand Down Expand Up @@ -73,7 +73,7 @@ ensuring robust monitoring and quick detection of potential issues.

The `sparrow` is provided as a small binary & a container image.

Please refer to the [release notes](https://github.com/caas-team/sparrow/releases) to get the latest version.
Please refer to the [release notes](https://github.com/telekom/sparrow/releases) to get the latest version.

### Binary

Expand All @@ -87,8 +87,8 @@ export RELEASE_VERSION=0.5.0
Download the binary:

```sh
curl https://github.com/caas-team/sparrow/releases/download/v${RELEASE_VERSION}/sparrow_${RELEASE_VERSION}_linux_amd64.tar.gz -Lo sparrow.tar.gz
curl https://github.com/caas-team/sparrow/releases/download/v${RELEASE_VERSION}/sparrow_${RELEASE_VERSION}_checksums.txt -Lo checksums.txt
curl https://github.com/telekom/sparrow/releases/download/v${RELEASE_VERSION}/sparrow_${RELEASE_VERSION}_linux_amd64.tar.gz -Lo sparrow.tar.gz
curl https://github.com/telekom/sparrow/releases/download/v${RELEASE_VERSION}/sparrow_${RELEASE_VERSION}_checksums.txt -Lo checksums.txt
```

Extract the binary:
Expand All @@ -99,15 +99,15 @@ tar -xf sparrow.tar.gz

### Container Image

The [sparrow container images](https://github.com/caas-team/sparrow/pkgs/container/sparrow) for
dedicated [release](https://github.com/caas-team/sparrow/releases) can be found in the GitHub registry.
The [sparrow container images](https://github.com/telekom/sparrow/pkgs/container/sparrow) for
dedicated [release](https://github.com/telekom/sparrow/releases) can be found in the GitHub registry.

### Helm

Sparrow can be installed via Helm Chart. The chart is available in the GitHub registry:

```sh
helm -n sparrow upgrade -i sparrow oci://ghcr.io/caas-team/charts/sparrow --create-namespace
helm -n sparrow upgrade -i sparrow oci://ghcr.io/telekom/charts/sparrow --create-namespace
```

The default settings are suitable for a local configuration. With the default Helm values, the sparrow loader uses a
Expand Down Expand Up @@ -151,12 +151,12 @@ sparrow run --sparrowName sparrow.telekom.de

### Image

Run a `sparrow` container by using e.g. `docker run ghcr.io/caas-team/sparrow`.
Run a `sparrow` container by using e.g. `docker run ghcr.io/telekom/sparrow`.

Pass the available configuration arguments to the container e.g. `docker run ghcr.io/caas-team/sparrow --help`.
Pass the available configuration arguments to the container e.g. `docker run ghcr.io/telekom/sparrow --help`.

Start the instance using a mounted startup configuration file
e.g. `docker run -v /config:/config ghcr.io/caas-team/sparrow --config /config/config.yaml`.
e.g. `docker run -v /config:/config ghcr.io/telekom/sparrow --config /config/config.yaml`.

## Configuration

Expand Down Expand Up @@ -710,9 +710,9 @@ The application itself and all end-user facing content will be made available in
The following channels are available for discussions, feedback, and support requests:

<!-- markdownlint-disable MD033 -->
| Type | Channel |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Issues** | <a href="/../../issues/new/choose" title="General Discussion"><img alt="Issues" src="https://img.shields.io/github/issues/caas-team/sparrow?style=flat-square"></a> |
| Type | Channel |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Issues** | <a href="/../../issues/new/choose" title="General Discussion"><img alt="Issues" src="https://img.shields.io/github/issues/telekom/sparrow?style=flat-square"></a> |
<!-- markdownlint-enable MD033 -->

## How to Contribute
Expand Down
16 changes: 11 additions & 5 deletions chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,19 @@ keywords:
- monitoring
version: 0.0.4
appVersion: "v0.5.0"
icon: https://github.com/caas-team/sparrow/blob/main/docs/img/sparrow.png
icon: https://github.com/telekom/sparrow/blob/main/docs/img/sparrow.png
sources:
- https://github.com/caas-team/sparrow
- https://github.com/telekom/sparrow
maintainers:
- name: eumel8
email: [email protected]
url: https://www.telekom.com
- name: y-eight
email: [email protected]
url: https://www.telekom.com
- name: puffitos
email: [email protected]
url: https://www.telekom.com
- name: ntreml
email: [email protected]
url: https://www.telekom.com
- name: lvlcn-t
email: [email protected]
url: https://www.telekom.com
14 changes: 8 additions & 6 deletions chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,27 @@ A Helm chart to install Sparrow

| Name | Email | Url |
| ---- | ------ | --- |
| eumel8 | <[email protected]> | <https://www.telekom.com> |
| y-eight | <[email protected]> | <https://www.telekom.com> |
| puffitos | <[email protected]> | <https://www.telekom.com> |
| ntreml | <[email protected]> | <https://www.telekom.com> |
| lvlcn-t | <[email protected]> | <https://www.telekom.com> |

## Source Code

* <https://github.com/caas-team/sparrow>
* <https://github.com/telekom/sparrow>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| checksConfig | object | `{}` | Check configuration of the Sparrow read on runtime see: https://github.com/caas-team/sparrow?tab=readme-ov-file#checks |
| checksConfig | object | `{}` | Check configuration of the Sparrow read on runtime see: https://github.com/telekom/sparrow?tab=readme-ov-file#checks |
| env | object | `{}` | |
| envFromSecrets | list | `[]` | extra environment variables Allows you to set environment variables through secrets you defined outside of the helm chart Useful for sensitive information like the http loader token |
| extraArgs | object | `{}` | Extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
| extraArgs | object | `{}` | Extra command line start parameters see: https://github.com/telekom/sparrow/blob/main/docs/sparrow_run.md |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"ghcr.io/caas-team/sparrow"` | |
| image.repository | string | `"ghcr.io/telekom/sparrow"` | |
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
Expand Down Expand Up @@ -64,7 +66,7 @@ A Helm chart to install Sparrow
| serviceMonitor.interval | string | `"30s"` | Sets the scrape interval |
| serviceMonitor.labels | object | `{}` | Additional label added to the service Monitor |
| serviceMonitor.scrapeTimeout | string | `"5s"` | Sets the scrape timeout |
| sparrowConfig | object | `{"loader":{"file":{"path":"/config/checks.yaml"},"interval":"30s","type":"file"},"name":"sparrow.com"}` | Sparrow configuration read on startup see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
| sparrowConfig | object | `{"loader":{"file":{"path":"/config/checks.yaml"},"interval":"30s","type":"file"},"name":"sparrow.com"}` | Sparrow configuration read on startup see: https://github.com/telekom/sparrow/blob/main/docs/sparrow_run.md |
| startupProbe | object | `{"enabled":false,"failureThreshold":10,"initialDelaySeconds":10,"path":"/","periodSeconds":5,"successThreshold":1,"timeoutSeconds":1}` | Specifies the configuration for a startup probe to check if the sparrow application is started. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ |
| tolerations | list | `[]` | |

8 changes: 4 additions & 4 deletions chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
replicaCount: 1

image:
repository: ghcr.io/caas-team/sparrow
repository: ghcr.io/telekom/sparrow
pullPolicy: IfNotPresent
# -- Overrides the image tag whose default is the chart appVersion.
tag: ""
Expand Down Expand Up @@ -127,7 +127,7 @@ tolerations: []
affinity: {}

# -- Extra command line start parameters
# see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md
# see: https://github.com/telekom/sparrow/blob/main/docs/sparrow_run.md
extraArgs: {}

# -- extra environment variables
Expand All @@ -141,7 +141,7 @@ envFromSecrets:
# key: SPARROW_LOADER_HTTP_TOKEN

# -- Sparrow configuration read on startup
# see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md
# see: https://github.com/telekom/sparrow/blob/main/docs/sparrow_run.md
sparrowConfig:
name: sparrow.com
loader:
Expand Down Expand Up @@ -176,7 +176,7 @@ sparrowConfig:
# projectId: ""

# -- Check configuration of the Sparrow read on runtime
# see: https://github.com/caas-team/sparrow?tab=readme-ov-file#checks
# see: https://github.com/telekom/sparrow?tab=readme-ov-file#checks
checksConfig: {}
# health:
# interval: 15s
Expand Down
6 changes: 3 additions & 3 deletions cmd/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ import (
"github.com/spf13/cobra"
"github.com/spf13/viper"

"github.com/caas-team/sparrow/internal/logger"
"github.com/caas-team/sparrow/pkg/config"
"github.com/caas-team/sparrow/pkg/sparrow"
"github.com/telekom/sparrow/internal/logger"
"github.com/telekom/sparrow/pkg/config"
"github.com/telekom/sparrow/pkg/sparrow"
)

const (
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/caas-team/sparrow
module github.com/telekom/sparrow

go 1.23

Expand Down
2 changes: 1 addition & 1 deletion internal/helper/retry.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (
"math"
"time"

"github.com/caas-team/sparrow/internal/logger"
"github.com/telekom/sparrow/internal/logger"
)

type RetryConfig struct {
Expand Down
4 changes: 2 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
package main

import (
"github.com/caas-team/sparrow/cmd"
"github.com/telekom/sparrow/cmd"
)

// Version is the current version of sparrow
// version is the current version of sparrow
// It is set at build time by using -ldflags "-X main.version=x.x.x"
var version string

Expand Down
2 changes: 1 addition & 1 deletion pkg/api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ import (
"net/http"
"time"

"github.com/caas-team/sparrow/internal/logger"
"github.com/go-chi/chi/v5"
"github.com/telekom/sparrow/internal/logger"
)

//go:generate moq -out api_moq.go . API
Expand Down
2 changes: 1 addition & 1 deletion pkg/checks/base.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ import (
"sync"
"time"

"github.com/caas-team/sparrow/internal/helper"
"github.com/getkin/kin-openapi/openapi3"
"github.com/prometheus/client_golang/prometheus"
"github.com/telekom/sparrow/internal/helper"
)

// DefaultRetry provides a default configuration for the retry mechanism
Expand Down
4 changes: 2 additions & 2 deletions pkg/checks/dns/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"strings"
"time"

"github.com/caas-team/sparrow/internal/helper"
"github.com/caas-team/sparrow/pkg/checks"
"github.com/telekom/sparrow/internal/helper"
"github.com/telekom/sparrow/pkg/checks"
)

const (
Expand Down
6 changes: 3 additions & 3 deletions pkg/checks/dns/dns.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ import (
"sync"
"time"

"github.com/caas-team/sparrow/internal/helper"
"github.com/caas-team/sparrow/internal/logger"
"github.com/caas-team/sparrow/pkg/checks"
"github.com/getkin/kin-openapi/openapi3"
"github.com/prometheus/client_golang/prometheus"
"github.com/telekom/sparrow/internal/helper"
"github.com/telekom/sparrow/internal/logger"
"github.com/telekom/sparrow/pkg/checks"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions pkg/checks/dns/dns_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ import (
"testing"
"time"

"github.com/caas-team/sparrow/pkg/checks"
"github.com/caas-team/sparrow/pkg/checks/health"
"github.com/telekom/sparrow/pkg/checks"
"github.com/telekom/sparrow/pkg/checks/health"

"github.com/stretchr/testify/assert"
)
Expand Down
2 changes: 1 addition & 1 deletion pkg/checks/dns/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
package dns

import (
"github.com/caas-team/sparrow/pkg/checks"
"github.com/prometheus/client_golang/prometheus"
"github.com/telekom/sparrow/pkg/checks"
)

// metrics defines the metric collectors of the DNS check
Expand Down
4 changes: 2 additions & 2 deletions pkg/checks/health/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"net/url"
"time"

"github.com/caas-team/sparrow/internal/helper"
"github.com/caas-team/sparrow/pkg/checks"
"github.com/telekom/sparrow/internal/helper"
"github.com/telekom/sparrow/pkg/checks"
)

const (
Expand Down
6 changes: 3 additions & 3 deletions pkg/checks/health/health.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ import (

"github.com/prometheus/client_golang/prometheus"

"github.com/caas-team/sparrow/internal/helper"
"github.com/caas-team/sparrow/internal/logger"
"github.com/caas-team/sparrow/pkg/checks"
"github.com/getkin/kin-openapi/openapi3"
"github.com/telekom/sparrow/internal/helper"
"github.com/telekom/sparrow/internal/logger"
"github.com/telekom/sparrow/pkg/checks"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions pkg/checks/health/health_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ import (
"testing"
"time"

"github.com/caas-team/sparrow/pkg/checks"
"github.com/caas-team/sparrow/pkg/checks/latency"
"github.com/telekom/sparrow/pkg/checks"
"github.com/telekom/sparrow/pkg/checks/latency"

"github.com/jarcoal/httpmock"
"github.com/stretchr/testify/assert"
Expand Down
2 changes: 1 addition & 1 deletion pkg/checks/health/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
package health

import (
"github.com/caas-team/sparrow/pkg/checks"
"github.com/prometheus/client_golang/prometheus"
"github.com/telekom/sparrow/pkg/checks"
)

// metrics contains the metric collectors for the Health check
Expand Down
4 changes: 2 additions & 2 deletions pkg/checks/latency/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"net/url"
"time"

"github.com/caas-team/sparrow/internal/helper"
"github.com/caas-team/sparrow/pkg/checks"
"github.com/telekom/sparrow/internal/helper"
"github.com/telekom/sparrow/pkg/checks"
)

const (
Expand Down
Loading
Loading