Skip to content

Commit

Permalink
Add Sidekiq user interface
Browse files Browse the repository at this point in the history
This makes the Sidekiq UI available to developers with production
access.

This has been implemented in the same way as in [Publishing API]
(alphagov/publishing-api#2839).
  • Loading branch information
brucebolt committed Sep 23, 2024
1 parent eba5135 commit fcf31d6
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
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
4 changes: 4 additions & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,8 @@
if AssetManager.s3.fake?
mount Rack::File.new(AssetManager.fake_s3.root), at: AssetManager.fake_s3.path_prefix, as: "fake_s3"
end

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

0 comments on commit fcf31d6

Please sign in to comment.