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

Add Sidekiq user interface #1494

Merged
merged 1 commit into from
Sep 23, 2024
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
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,23 @@ In non-production environments if the `AWS_S3_BUCKET_NAME` environment variable

Check the [docs](docs/) directory for detailed instructions, including API documentation.

## Viewing the Sidekiq UI

We have access to the Sidekiq UI but because Asset Manager doesn't have a
frontend we have to use port forwarding to see it in our live environments.

You'll need to have access to our EKS clusters before you can follow these
instructions. There's [documentation here](https://docs.publishing.service.gov.uk/kubernetes/get-started/access-eks-cluster/#access-a-cluster-that-you-have-accessed-before) on how to do that. This means that
you'll need full production access before you can view the Sidekiq UI.

To view the UI run:

```
kubectl -n apps port-forward deployment/asset-manager 8080:8080
```

and then navigate to localhost:8080/sidekiq

## Licence

[MIT License](LICENCE)
Expand Down
3 changes: 3 additions & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@
if AssetManager.s3.fake?
mount Rack::File.new(AssetManager.fake_s3.root), at: AssetManager.fake_s3.path_prefix, as: "fake_s3"
end

require "sidekiq_unique_jobs/web"
mount Sidekiq::Web, at: "/sidekiq"
end