Within the period of AI and machine studying (ML), there’s a rising emphasis on enhancing safety— particularly in IT contexts. On this put up, we exhibit how your group can scale back the end-to-end burden of resolving common challenges skilled by your IT help groups—from understanding errors and reviewing diagnoses, remediation steps, and related documentation, to opening exterior help tickets utilizing frequent third-party providers resembling Jira.
We present how Amazon Q Enterprise can streamline your end-to-end troubleshooting processes by utilizing your preexisting documentation and ticketing methods whereas approaching complicated IT points in a conversational dialogue. This resolution illustrates the advantages of incorporating Amazon Q as a supplemental device in your IT stack.
Advantages of Amazon Q Enterprise
The next are some related advantages of Amazon Q Enterprise:
- Scalability – As an AWS cloud-based service, Amazon Q is extremely scalable and capable of deal with quite a few concurrent requests from a number of staff with out efficiency degradation. This makes it appropriate for organizations with a big IT division consisting of many staff who intend to make use of Amazon Q as an clever agent assistant.
- Elevated productiveness – As a result of Amazon Q can deal with a big quantity of buyer inquiries concurrently, this frees up human staff (resembling IT help engineers) to deal with extra complicated or specialised duties, thereby enhancing total productiveness.
- Pure language understanding (NLU) – Customers can work together with the Amazon Q Enterprise software utilizing pure language (resembling English). This allows extra pure and intuitive conversational experiences with out requiring your brokers to study new APIs or languages.
- Customization and personalization – Builders can customise the information base and responses to cater to the particular wants of their software and customers, enabling extra customized experiences. On this put up, we talk about an IT help use case for Amazon Q Enterprise and tips on how to configure it to index and search customized audit logs.
Resolution overview
Our use case focuses on the challenges round troubleshooting, particularly inside methods and purposes for IT help and assist desk operations. We use Amazon Q Enterprise to coach on our inner documentation and runbooks to create a tailor-made Amazon Q software that provides customized directions, supply hyperlinks to related documentation, and seamless integration with ticketing providers like Jira for escalation necessities. Our purpose is to scale back the effort and time required for IT help groups and others to diagnose challenges, overview runbooks for remediation, and automate the escalation and ticketing course of.
The next diagram illustrates the answer structure.
The answer consists of the next key integrations:
- Jira plugin – Amazon Q Enterprise helps integration with Jira; you should use the AI assistant UI to look, learn, create, and delete Jira tickets. Adjustments made utilizing this plugin by Amazon Q can then be considered inside your Jira console.
- Net crawling – Amazon Q Enterprise makes use of net crawlers to index and ingest product documentation web sites, ensuring that the newest info is accessible for answering queries.
- Amazon S3 connector – Organizations can add product paperwork on to Amazon Easy Storage Service (Amazon S3), enabling Amazon Q Enterprise to entry and incorporate this info into its information base.
- Jira knowledge supply – In case your Jira surroundings not often adjustments, or if you wish to have extra granular management over Amazon Q interactions with Jira, then you should use Jira as a easy knowledge supply. Right here, Amazon Q may have read-only entry to Jira.
Conditions
As a prerequisite to deploying this resolution, you’ll need to arrange Jira and Confluence utilizing an Atlassian account. If you have already got these arrange, you should use your present account. In any other case, you possibly can create an Atlassian account and arrange Jira and Confluence utilizing the free model.
- Join along with your electronic mail or by a social id supplier. Should you join utilizing electronic mail, you should confirm your electronic mail by a One Time Password (OTP).
- Enter a reputation in your website and select Proceed.
- Select Different and select Proceed.
- If requested for a beginning template, you possibly can select the Venture administration template and select Begin now.
- Enter a reputation in your challenge and select Get began.
Your UI ought to now seem like the next screenshot.
Now you’ve got created an Atlassian account and Jira challenge.
For instance functions, we created a number of duties inside the Jira console. We are going to come again to those later.
Create an Amazon Q software
You are actually able to create an Amazon Q software:
- Register to your AWS account on the AWS Administration Console and set your most well-liked AWS Area.
- Open the Amazon Q console.
- Should you haven’t already, full the steps to connect with AWS IAM Identification Middle, creating both a corporation occasion or account occasion.
After you’ve got accomplished your configuration of IAM Identification Middle and linked it inside Amazon Q, it’s best to see the next success message on the Amazon Q console.
- On the Amazon Q Enterprise console, select Purposes within the navigation pane, then select Create an software.
- For Software title, enter a reputation (for instance,
QforITTeams
). - Depart the remaining choices as default and select Subsequent.
- You might have the selection of choosing an present Amazon Kendra retriever or utilizing the Amazon Q native retriever. For extra info on the retriever choices, see Creating an index for an Amazon Q Enterprise software. For this put up, we use the native retriever.
- Hold the opposite default choices and select Subsequent.
Amazon Q affords a collection of default knowledge sources so that you can select from, together with Amazon S3, Amazon Relational Database Service (Amazon RDS), Slack, Salesforce, Confluence, code repositories in GitHub, on-premises shops (resembling IBM DB2), and extra. For our pattern arrange, we’re utilizing pattern AWS Effectively-Architected documentation, for which we will use an online crawler. We additionally need to use some pattern runbooks (we’ve got already generated and uploaded these to an S3 bucket).
Let’s arrange our Amazon S3 knowledge supply first.
- For Add a knowledge supply, select Amazon S3.
- Below Title and outline, enter a reputation and outline.
- Full the steps so as to add your Amazon S3 knowledge supply. For our use case, we create a brand new AWS Identification and Entry Administration (IAM) service position in line with the AWS suggestions for normal use instances. AWS will mechanically propagate the position for us following the precept of least privilege.
- After you add the information supply, run the sync by selecting Sync now.
Wait 5–10 minutes in your knowledge to complete syncing to Amazon Q.
Now let’s add our net crawler and hyperlink to some AWS Effectively-Architected documentation.
- Add a second knowledge supply and select Net crawlers.
- Below Supply, choose Supply URLs and enter the supply URLs you need to crawl.
For this use case, we entered some hyperlinks to public AWS documentation; you’ve got the choice to configure authentication and an online proxy in an effort to crawl intranet paperwork as properly.
- After you create the information supply, select Sync now to run the sync.
Add an IAM Identification Middle consumer
Whereas our knowledge sources are busy syncing, let’s create an IAM Identification Middle consumer for us to check the Amazon Q Enterprise software net expertise:
- On the Amazon Q Enterprise console, navigate to your software.
- Below Teams and customers, select Handle entry and subscriptions, and select Add teams and customers.
- Choose Add new customers and select Subsequent.
- After you create the consumer, you possibly can add it by selecting Assign present customers and teams and looking for the consumer by first title.
- After you add the consumer, you possibly can edit their subscription entry. We improve our consumer’s entry to Q Enterprise Professional for our testing.
Deploy the online expertise
After the information sources have accomplished their sync, you possibly can transfer to the testing stage to verify issues are working thus far:
- On the Amazon Q Enterprise console, select Purposes within the navigation pane.
- Choose your software and select Deploy net expertise.
- On the applying particulars web page, select Customise net expertise.
- Customise the title, subtitle, and welcome message as wanted, then select Save.
- Select View net expertise.
Let’s check some prompts on the information that our Amazon Q software has seen.
First, let’s ask some questions across the offered runbooks saved in our S3 bucket that we beforehand added as a knowledge supply to our software. Within the following instance, we ask about info for restarting an Amazon Elastic Compute Cloud (Amazon EC2) occasion.
As proven within the following screenshot, Amazon Q has not solely answered our query, but it surely additionally cited its supply for us, offering a hyperlink to the .txt file that accommodates the runbook for Restarting an EC2 Occasion.
Let’s ask a query concerning the Effectively-Architected webpages that we crawled. For this question, we will ask if there’s a device we will use to enhance our AWS structure. The next screenshot exhibits the reply.
Arrange Jira as a knowledge supply
On this part, we arrange Jira as a knowledge supply for our Amazon Q software. This may enable Amazon Q to look knowledge in Jira. For directions, see Connecting Jira to Amazon Q Enterprise.
After you’ve got arrange Jira as a knowledge supply, check out your Amazon Q Enterprise software. Go to the online expertise chat interface URL and ask it about certainly one of your Jira tickets. The next screenshot exhibits an instance.
Arrange a Jira plugin
What if you happen to encounter a state of affairs the place your consumer, an IT help skilled, can’t discover the answer with the offered inner paperwork and runbooks that Amazon Q has been skilled on? The next step may be to open a ticket in Jira. Let’s add a plugin for Jira that means that you can submit a Jira ticket by the Amazon Q chat interface. For extra particulars, see Configuring a Jira Cloud plugin for Amazon Q Enterprise. Within the earlier part, we added Jira as a knowledge supply, permitting Amazon Q to look knowledge contained in Jira. By including Jira as a plugin, we’ll enable Amazon Q to carry out actions inside Jira.
Full the next steps so as to add the Jira plugin:
- On the Amazon Q Enterprise console, navigate to your software.
- Select Plugins within the navigation pane.
- Select Add plugin.
- For Plugin title, enter a reputation.
- For Area URL, enter
https://api.atlassian.com/ex/jira/yourInstanceID
, the place the worth ofyourInstanceID
is the worth athttps://my-site-name.atlassian.web/_edge/tenant_info
. - For OAuth2.0, choose Create a brand new secret, and enter your Jira consumer ID and consumer secret.
Should you require help retrieving these values, check with the conditions.
- Full creating your plugin.
After you’ve got created the plugin, return to the applying net expertise to attempt it out. The primary time you employ the Jira plugin inside the Amazon Q chat interface, you may be requested to authorize entry. The request will look much like the next screenshots.
After you present Amazon Q authorization to entry Jira, you’re prepared to check out the plugin.
First, let’s ask Amazon Q to create some draft textual content for our ticket.
Subsequent, we ask Amazon Q to make use of this context to create a job in Jira. That is the place we use the plugin. Select the choices menu (three dots) subsequent to the chat window and select the Jira plugin.
Ask it to generate a Jira job. Amazon Q will mechanically acknowledge the dialog and enter its knowledge inside the Jira ticket template for you, as proven within the following screenshot. You’ll be able to customise the fields as wanted and select Submit.
It is best to obtain a response much like the next screenshot.
Amazon Q has created a brand new job for us in Jira. We will affirm that by viewing our Jira console. There’s a job for updating the IT runbooks to fulfill catastrophe restoration aims.
If we open that job, we will affirm that the data offered matches the data we handed to the Jira plugin.
Now, let’s check out retrieving an present ticket and modifying it. Within the following screenshot, Amazon Q is ready to search by our Jira Points and accurately determine the precise job we have been referring to.
We will ask Amazon Q about some attainable actions we will take.
Let’s ask Amazon Q to maneuver the duty to the “In Progress” stage.
The next screenshot exhibits the up to date view of our Jira duties on the Jira console. The ticket for debugging the Amazon DynamoDB software has been moved to the In Progress stage.
Now, suppose we wished to view extra info for this job. We will merely ask Amazon Q. This protects us the difficulty of getting to navigate our means across the Jira UI.
Amazon Q is even capable of extract metadata concerning the ticket, resembling last-updated timestamps, its creator, and different elements.
You may also delete duties in Jira utilizing the Amazon Q chat interface. The next is an instance of deleting the DynamoDB ticket. You can be prompted to verify the duty ID (key). The duty shall be deleted after you affirm.
Now, if we view our Jira console, the corresponding job is gone.
Clear up
To scrub up the assets that you’ve provisioned, full the next steps:
- Empty and delete any S3 buckets you created.
- Downgrade your IAM Identification Middle consumer subscription to Amazon Q.
- Delete any Amazon Q associated assets, together with your Amazon Q Enterprise software.
- Delete any extra providers or storage provisioned throughout your exams.
Conclusion
On this put up, we configured IAM Identification Middle for Amazon Q and created an Amazon Q software with connectors to Amazon S3, net crawlers, and Jira. We then custom-made our Amazon Q software for a use case focusing on IT specialists, and we despatched some check prompts to overview our runbooks for concern decision in addition to to get solutions to questions relating to AWS Effectively-Architected practices. We additionally added a plugin for Jira in order that IT help groups can create Jira points and tickets mechanically with Amazon Q, bearing in mind the complete context of our dialog.
Check out Amazon Q Enterprise in your personal use case, and share your suggestions within the feedback. For extra details about utilizing Amazon Q Enterprise with Jira, see Enhance the productiveness of your buyer help and challenge administration groups utilizing Amazon Q Enterprise and Atlassian Jira.
Concerning the Authors
Dylan Martin is a Options Architect (SA) at Amazon Net Companies based mostly within the Seattle space. Dylan focuses on creating Generative AI options for brand spanking new service and have launches. Exterior of labor, Dylan enjoys motorcycling and learning languages.
Ankit Patel is a Options Developer at AWS based mostly within the NYC space. As a part of the Prototyping and Buyer Engineering (PACE) crew, he helps prospects deliver their revolutionary concepts to life by fast prototyping; utilizing the AWS platform to construct, orchestrate, and handle customized purposes.