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: improve documentation on how to use BackgroundJobs #151

Open
fgheysels opened this issue Jun 28, 2022 · 4 comments
Open

Doc: improve documentation on how to use BackgroundJobs #151

fgheysels opened this issue Jun 28, 2022 · 4 comments
Labels
az-active-directory All issues related to Azure Active Directory background jobs documentation All issues related to documentation
Projects
Milestone

Comments

@fgheysels
Copy link
Member

fgheysels commented Jun 28, 2022

I was going through the documentation regarding the backgroundjob that can be used to detect client-secrets that are about to expire, and it is actually not very clear to me on how I should use it.

The documentation describes:

image

What exactly does this mean ? Does this mean that I can use this background-job from within an API for instance ? Can we elaborate in the documentation a little bit more about this ?
Actually, I personally wouldn't like to do it this way. Wouldn't it be preferred to create a dedicated component for this ? Might be a console app which is running in a container or an Azure Function.

Now that I'm typing this, I think we can extend this for all kind of Background Jobs.
I think it would be a good idea to create a page which informs users with best practices on how to implement background jobs, and maybe provide a skeleton that they can use to implement a component that is used to host background jobs.

@pim-simons , @stijnmoreels , any opinions?

@stijnmoreels
Copy link
Member

What exactly does this mean ? Does this mean that I can use this background-job from within an API for instance ?

Yes, you could. All background jobs are written as hosted services, so it could be part of a regular job of you application.

and maybe provide a skeleton that they can use to implement a component that is used to host background jobs

We have already some project templates that use these background jobs, that seems like a good place to put these things, no?

@stijnmoreels stijnmoreels added this to To do in Roadmap via automation Jun 29, 2022
@stijnmoreels stijnmoreels added this to the v0.5 milestone Jun 29, 2022
@stijnmoreels stijnmoreels added documentation All issues related to documentation az-active-directory All issues related to Azure Active Directory background jobs labels Jun 29, 2022
@stijnmoreels
Copy link
Member

Maybe some user guides can help here, too.

@stijnmoreels
Copy link
Member

stijnmoreels commented Aug 24, 2022

Something I'm thinking about: several of our background jobs are about integrating with other components: auto restart message pump, invalidate secret store... if they are run in another app, they won't have access to the message pump or secret store code.
So, they have to be in the same app for it to work.

(In case of the auto-restart message pump background job: the job won't even be available without registering the message pump).

So, the 'usage' sections are actually the ones that are recommended, like it is now.

@stijnmoreels
Copy link
Member

Moving this to v1.1.0 to prioritize .NET 8 support.

@stijnmoreels stijnmoreels modified the milestones: v0.5, v1.1.0 Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
az-active-directory All issues related to Azure Active Directory background jobs documentation All issues related to documentation
Projects
Roadmap
  
To do
Development

No branches or pull requests

2 participants