Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @gsavage's task in 2m 34s —— View job Doc reviewRe-reviewed at Improvements1. The CloudFormation template has two different origins, and neither is followable — Still open from the previous pass.
One of these is wrong, and neither gives a URL or a UI navigation path, so a reader cannot complete step 1 of the only setup page. Compounding it: the template takes Pick one source of truth, state it identically on both pages, and add the public S3/HTTPS URL if there is one. Fix this → 2. "All supported resources" is never resolved to a list — Still open from the previous pass, and the new entry point makes it sharper. The overview never names a resource type in its own right; ECS and Lambda appear only incidentally at Name the supported types explicitly in Finding resources — ECS and Lambda for this beta — and qualify the sentence at Suggestions3. New Terraform-page section leaves the drift question unanswered — 4. Multi-region is promised but not explained — 2 Improvements, 2 Suggestions, 0 Critical. Nothing blocks the merge given the BETA framing and the stated goal of gathering feedback early — but finding 1 makes the getting-started page unusable as written, so it is worth closing before this ships even as a beta page. |
The Kosli Capture Managed service is still in the design phase, so the content here is marked as "BETA". This PR adds documentation on the overall service, how to get started with it, and how it is secured. The purpose of making the documentation available, merged, before the build is complete is to allow our customers to provide feedback on the overall design and security of the solution.
df70813 to
7c895f0
Compare
|
|
||
| ## Kosli Capture permissions | ||
|
|
||
| The Kosli Capture managed service uses the public AWS APIs to extract information about your cloud environments. In order to do this, you need to provide Kosli with an IAM role that allows access to these APIs. The role is created and owned by you. Kosli publishes a CloudFormation template, for use in AWS, showing the permissions needed. The template is publicly accessible and can be used directly within an `aws cloudformation create-stack` call. |
There was a problem hiding this comment.
Kosli publishes a CloudFormation template, for use in AWS, showing the permissions needed
Where is this publicly accessible?
There was a problem hiding this comment.
It will be - Claude asked me the same thing :-)
I didn't want to include a link to the template yet because it is still being worked on. But yes, it will be in an S3 bucket with a public-read policy. A link to the template will be included in the new settings screen.
There was a problem hiding this comment.
Feedback from a customer, this morning, was that they don't want to use CloudFormation. A Terraform module might work for them, otherwise they will handle the creation of the role.
Based on that feedback, I think we may want to restructure this page -- it currently mixes CloudFormation and security in the same document.
| --- | ||
|
|
||
| <Warning> | ||
| Kosli Capture is still in active development. Its capabilities and configuration format may change, and onboarding is done together with Kosli's Customer Success team. |
There was a problem hiding this comment.
What is CS role on onboarding, or could it be self-serviceable?
There was a problem hiding this comment.
The design and rollout of Kosli Capture is still being designed. When I wrote that sentence originally, I imagined writing a play-book for CS. We now appear to be converging on a process that shouldn't need much/any CS involvement.
That sentence was added to help customers understand that this isn't something they can do themselves yet.
| for the isolation model and the full list of permissions. | ||
|
|
||
| ## Hands-off operation | ||
|
|
There was a problem hiding this comment.
I wonder, what if security permissions change?
There was a problem hiding this comment.
If the permissions we need change (for example we realise we need to read tags), then Kosli Capture might not work for the customer until they update their IAM role.
If the customer changes the IAM role and removes permissions we require, then Kosli Capture will stop working.
Do you think we need to include this in the documentation today?
The Kosli Capture Managed service is still in the design phase, so the content here is marked as "BETA". This PR adds documentation on the overall service, how to get started with it, and how it is secured.
The purpose of making the documentation available, merged, before the build is complete is to allow our customers to provide feedback on the overall design and security of the solution.