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

Doc/opensource #20

Merged
merged 3 commits into from
Nov 27, 2023
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
5 changes: 3 additions & 2 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2022 Deutsche Telekom IT GmbH.
Copyright (c) 2023 Deutsche Telekom IT GmbH.

This project is licensed under Apache License, Version 2.0;
you may not use them except in compliance with the License.
Expand All @@ -9,4 +9,5 @@ Contributors:
Maximilian Schubert [y-eight], Deutsche Telekom IT GmbH
Niklas Treml [niklastreml], Deutsche Telekom IT GmbH
Bruno Bressi [puffitos], Deutsche Telekom IT GmbH
Nico Feulner [nico151999], Deutsche Telekom IT GmbH
Nico Feulner [nico151999], Deutsche Telekom IT GmbH
Tom Vendolsky [lvlcn-t], Deutsche Telekom IT GmbH
18 changes: 18 additions & 0 deletions cmd/gen-docs.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package cmd

//go:generate go run ../main.go gen-docs --path ../docs
Expand Down
18 changes: 18 additions & 0 deletions cmd/root.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package cmd

import (
Expand Down
18 changes: 18 additions & 0 deletions cmd/run.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package cmd

import (
Expand Down
2 changes: 1 addition & 1 deletion docs/sparrow.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ The check results are exposed via an API.
* [sparrow gen-docs](sparrow_gen-docs.md) - Generate markdown documentation
* [sparrow run](sparrow_run.md) - Run sparrow

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
2 changes: 1 addition & 1 deletion docs/sparrow_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ See each sub-command's help for details on how to use the generated script.
* [sparrow completion powershell](sparrow_completion_powershell.md) - Generate the autocompletion script for powershell
* [sparrow completion zsh](sparrow_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
2 changes: 1 addition & 1 deletion docs/sparrow_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ sparrow completion bash

* [sparrow completion](sparrow_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
2 changes: 1 addition & 1 deletion docs/sparrow_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ sparrow completion fish [flags]

* [sparrow completion](sparrow_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
2 changes: 1 addition & 1 deletion docs/sparrow_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ sparrow completion powershell [flags]

* [sparrow completion](sparrow_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
2 changes: 1 addition & 1 deletion docs/sparrow_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ sparrow completion zsh [flags]

* [sparrow completion](sparrow_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
2 changes: 1 addition & 1 deletion docs/sparrow_gen-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ sparrow gen-docs [flags]

* [sparrow](sparrow.md) - Sparrow, the infrastructure monitoring agent

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
20 changes: 11 additions & 9 deletions docs/sparrow_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ sparrow run [flags]
### Options

```
-h, --help help for run
--loaderHttpRetryCount int http loader: Amount of retries trying to load the configuration (default 3)
--loaderHttpRetryDelay int http loader: The initial delay between retries in seconds (default 1)
--loaderHttpTimeout int http loader: The timeout for the http request in seconds (default 30)
--loaderHttpToken string http loader: Bearer token to authenticate the http endpoint
--loaderHttpUrl string http loader: The url where to get the remote configuration
--loaderInterval int defines the interval the loader reloads the configuration in seconds (default 300)
-l, --loaderType string defines the loader type that will load the checks configuration during the runtime (default "http")
--apiListeningAddress string api: The address the server is listening on (default ":8080")
-h, --help help for run
--loaderFilePath string file loader: The path to the file to read the runtime config from (default "config.yaml")
--loaderHttpRetryCount int http loader: Amount of retries trying to load the configuration (default 3)
--loaderHttpRetryDelay int http loader: The initial delay between retries in seconds (default 1)
--loaderHttpTimeout int http loader: The timeout for the http request in seconds (default 30)
--loaderHttpToken string http loader: Bearer token to authenticate the http endpoint
--loaderHttpUrl string http loader: The url where to get the remote configuration
--loaderInterval int defines the interval the loader reloads the configuration in seconds (default 300)
-l, --loaderType string defines the loader type that will load the checks configuration during the runtime. The fallback is the fileLoader (default "http")
```

### Options inherited from parent commands
Expand All @@ -33,4 +35,4 @@ sparrow run [flags]

* [sparrow](sparrow.md) - Sparrow, the infrastructure monitoring agent

###### Auto generated by spf13/cobra on 23-Nov-2023
###### Auto generated by spf13/cobra on 27-Nov-2023
18 changes: 18 additions & 0 deletions internal/helper/retry.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package helper

import (
Expand Down
18 changes: 18 additions & 0 deletions internal/helper/retry_test.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package helper

import (
Expand Down
18 changes: 18 additions & 0 deletions internal/logger/logger.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package logger

import (
Expand Down
18 changes: 18 additions & 0 deletions main.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package main

import (
Expand Down
18 changes: 18 additions & 0 deletions pkg/api/routingtree.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package api

import (
Expand Down
18 changes: 18 additions & 0 deletions pkg/api/routingtree_test.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package api

import (
Expand Down
18 changes: 18 additions & 0 deletions pkg/checks/checks.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package checks

import (
Expand Down
18 changes: 18 additions & 0 deletions pkg/checks/errors.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package checks

import "errors"
Expand Down
18 changes: 18 additions & 0 deletions pkg/checks/health.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package checks

import (
Expand Down
18 changes: 18 additions & 0 deletions pkg/checks/health_test.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package checks

import (
Expand Down
18 changes: 18 additions & 0 deletions pkg/checks/oapi.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// sparrow
// (C) 2023, Deutsche Telekom IT GmbH
//
// Deutsche Telekom IT GmbH and all other contributors /
// copyright owners license this file to you under the Apache
// License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package checks

import (
Expand Down
Loading