diff --git a/README.md b/README.md index 47b95eb..2cf708f 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ http://status-cake-exporter.default.svc:8000 | Setting | Required | Default | |--------------------------------------|----------|---------| -| USERNAME | Yes | Null | | API_KEY | Yes | Null | | TAGS | No | Null | | LOG_LEVEL | No | info | @@ -34,14 +33,13 @@ http://status-cake-exporter.default.svc:8000 The following will expose the exporter at `localhost:8000`: ```sh -export USERNAME=statuscakeuser export API_KEY=xxxxxxxx -docker run -d -p 8000:8000 --env USERNAME --env API_KEY ghcr.io/chelnak/status-cake-exporter:latest +docker run -d -p 8000:8000 --env API_KEY ghcr.io/chelnak/status-cake-exporter:latest ``` ### Kubernetes -To get up and running quickly, use [examples/manifest.yml](examples/manifest.yml) as an example. You will need to create a secret named `status-cake-api-token` containing your `USERNAME` and `API_KEY` first. +To get up and running quickly, use [examples/manifest.yml](examples/manifest.yml) as an example. You will need to create a secret named `status-cake-api-token` containing your `API_KEY` first. Otherwise, you can use the Helm Chart provided in [chart/status-cake-exporter](chart/status-cake-exporter/README.md). @@ -55,8 +53,6 @@ To get up and running quickly, use [examples/grafana-example.json](examples/graf Usage: status-cake-exporter [OPTIONS] Options: - --username TEXT Username for the account. This is only required for - legacy accounts. [env var: USERNAME] --api-key TEXT API Key for the account. [env var: API_KEY; required] --tags TEXT A comma separated list of tags used to filter tests diff --git a/status_cake_exporter/app.py b/status_cake_exporter/app.py index e119140..c46ae38 100644 --- a/status_cake_exporter/app.py +++ b/status_cake_exporter/app.py @@ -13,11 +13,6 @@ def exporter( - username: str = typer.Option( - "", - help="Username for the account. This is only required for legacy accounts. (DEPRECATED)", - envvar="USERNAME", - ), api_key: str = typer.Option(..., help="API Key for the account.", envvar="API_KEY"), tags: str = typer.Option( "", @@ -40,7 +35,6 @@ def exporter( The entry point for the exporter. This will start the exporter and begin collecting metrics. Args: - username: The username for the account. This is only required for legacy accounts. api_key: The api key for the account. tags: A comma separated list of tags used to filter tests returned from the api. log_level: The log level of the application. Value can be one of {debug, info, warn, error}. @@ -51,11 +45,6 @@ def exporter( try: configure_logging(log_level) - if username: - logger.warning( - "The username option is deprecated and will be removed in a future release." - ) - logger.info(f"Starting web server on port: {port}") start_http_server(port)