-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add Kosli Capture Managed Service page #380
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
Changes from all commits
193060c
0d7fb53
7afa53c
b6dd574
6e1d5c5
0a1e3f9
ce043e6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| title: "Getting Started with Kosli Capture" | ||
| sidebarTitle: "Getting started" | ||
| description: "Learn how to configure Kosli Capture for your organization" | ||
| tag: "ALPHA" | ||
| --- | ||
|
|
||
| <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. | ||
| </Warning> | ||
|
|
||
| Kosli Capture is a managed service that runs on Kosli's infrastructure and connects to your cloud platform to observe the resources deployed there. To get set up with Kosli Capture you need to grant permissions to Kosli's cloud account and provide configuration details for how your tags should map to environments within Kosli. | ||
|
|
||
| ## Overview | ||
|
|
||
| Getting started with Kosli Capture involves two stages: | ||
|
|
||
| <Steps> | ||
| <Step title="Prepare your environment"> | ||
| Create an IAM role in your AWS account specifically for Kosli Capture. Kosli provides a CloudFormation template to simplify this process. The template requires a shared secret, which Kosli provides to you. | ||
| </Step> | ||
| <Step title="Enable Kosli Capture"> | ||
| Enable Kosli Capture for your Kosli org, and the regular snapshots appear in Kosli. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Prepare your environment | ||
|
|
||
| In order for Kosli Capture to reach into your cloud, to discover your ECS clusters and Lambdas, you need to grant permission to Kosli to do so. Within AWS this requires the creation of an IAM role that Kosli can assume; the role will exist within your AWS account. | ||
|
|
||
| To simplify this process, Kosli has created a CloudFormation template that contains a role with the minimum set of permissions needed by Kosli Capture. The role can be assumed by Kosli and is protected by an external Id; each organization within Kosli has its own external Id. | ||
|
|
||
| The CloudFormation template can be deployed within an AWS account, or can be attached to an AWS Organizational Unit (OU) as a StackSet; this latter option ensures the correct IAM permissions are rolled out to all AWS accounts within the OU. | ||
|
|
||
| When used, the CloudFormation template will send your AWS account id to Kosli, so that we are automatically notified that your account is ready to be included in Kosli Capture. Similarly, if you delete the CloudFormation stack we will be notified and know that the account is no longer to be included. | ||
|
|
||
| ## Enable Kosli Capture | ||
|
|
||
| When you have created the IAM role, using the CloudFormation template, you can activate Kosli Capture within the Kosli user-interface. Kosli Capture runs on a five-minute schedule, and once you have enabled it, Kosli Capture will pick up your environment the next time it runs - you should see environments and snapshots appearing within a few minutes. | ||
|
|
||
| ## Excluding resources | ||
|
|
||
| If there are resources you do not wish to include within a Kosli Capture Managed snapshot, for example an ECS cluster that you consider to be out of scope, you can add an AWS tag to it indicating that the item should be skipped. Adding a tag with the name `kosli.capture` and the value `false` will ensure that Kosli Capture skips over that resource. | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,54 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| title: "Kosli Capture Managed Service" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sidebarTitle: "Kosli Capture" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: "Learn how the Kosli Capture Managed Service snapshots your cloud environments from Kosli's infrastructure, with no software to install." | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tag: "ALPHA" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gsavage marked this conversation as resolved.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| </Warning> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Capture is a managed service that runs on Kosli's infrastructure and connects to your cloud platform to observe the resources deployed there. You grant Kosli Capture a set of permissions, and it uses them to run a `kosli snapshot` every few minutes against the infrastructure you have allowed it to scan. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli also supports reporting from your own cloud accounts by running the Kosli CLI on a schedule. Kosli Capture inverts this, with Kosli running the regular [snapshots](/getting_started/environments) so there is no software for you to install. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
gsavage marked this conversation as resolved.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| To set it up for your organization, see [Getting started with Kosli Capture](/administration/kosli_capture/getting_started). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Overview | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Capture connects to your cloud accounts using permissions that you manage. You configure Kosli Capture by activating it for different AWS services, and Kosli Capture uses the permissions to regularly reach into your estate and record snapshots, sending the data into your Kosli organization. Kosli Capture uses details about your infrastructure, such as the name of an ECS cluster, to build environments within Kosli. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Security | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The security of your cloud infrastructure is the primary driver behind the internal architecture of the Kosli Capture managed service. Kosli Capture runs as a shared, autoscaled service, but each job runs under a role that is scoped to one customer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+22
to
+24
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion — this section duplicates the dedicated security page without linking to it.
A single forward pointer at the end of this section, e.g. "For the IAM role, trust policy and full permission list, see Kosli Capture security." — the security page has no link back to the overview either, so the pair is currently only navigable via the sidebar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * A Kosli Capture worker picks up a job for your organization and assumes a Kosli-side role that exists only for your organization. Only that role is permitted to call AssumeRole into A's account with A's ExternalId. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * When the job finishes, those credentials are discarded. A worker holding credentials for your cloud account has no path to anyone else's account. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| * The trust policy's ExternalId lives in Parameter Store and is readable only by the Kosli-side role for your organization. The shared task role cannot read any customer's ExternalId. Separation is enforced by IAM, not by application code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Catpure itself does not hold any customer data. Snapshots taken by Kosli Catpure are immediately sent to Kosli through the same ingest path as your existing pipelines. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+24
to
+30
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — this section still refers to an unnamed "customer A". Line 24 reads "Only that role is permitted to call AssumeRole into A's account with A's ExternalId." Nothing on the page defines "A" — it reads as a leftover from an internal design document where customers were labelled A and B. This is the section a reader is most likely to forward to their own security team, and it contains an unresolvable referent in its first bullet. Three more defects in the same block:
Suggested change
Comment on lines
+24
to
+30
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — this section still refers to an unnamed "customer A". Line 26 reads "Only that role is permitted to call AssumeRole into A's account with A's ExternalId". Nothing on the page defines "A" — it reads as a leftover from an internal design document where customers were labelled A and B. This is the section a reader is most likely to forward to their own security team, and the referent is unresolvable in its first bullet. Also in this block: line 24 has no closing full stop, line 30 spells the product "Kosli Catpure" twice, and the page uses "ExternalId" here but "external ID" at lines 52–54 — worth reserving the camel-case form for the literal YAML key shown at
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Hands-off operation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Capture has been designed to operate with no on-going support from you. Once the initial security permissions have been created, Kosli capture will continue to operate in a headless mode. Monitoring, maintenance and rotation of API keys is all handed automatically. As your cloud infrastructure changes over time, Kosli capture will continue to find resources without you needing to do anything; your application teams do not need to take any action in order to onboard their products and services into Kosli. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Finding resources | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Capture finds all supported resources within your AWS accounts, and determines which Kosli environment should hold the snapshots. Kosli Capture will create physical environments for you. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Capture can [filter out resources based on AWS tags](/administration/kosli_capture/getting_started#excluding-resources). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| As your cloud environment evolves, such as the addition of new ECS clusters or the retirement of existing Lambdas, Kosli Capture automatically detects the changes. Because Kosli Capture creates physical environments as needed, when your infrastructure changes, Kosli will keep up. No changes to the configuration created during the initial setup are required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — environment auto-creation is now stated twice. Line 38 ends with "Kosli Capture will create physical environments for you", and this sentence repeats it four lines later ("Because Kosli Capture creates physical environments as needed..."). The claim only needs to land once; here the useful new information is that evolving infrastructure is handled without reconfiguration.
Suggested change
If you take this, drop the trailing sentence on line 38 ("Kosli Capture will create physical environments for you.") so the claim appears once, in the paragraph that explains why it matters.
Comment on lines
+38
to
+42
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — "all supported resources" is undefined, and line 42 still points at a configuration that no longer exists. Two stale references from the same removals:
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Multiple AWS accounts | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kosli Capture can operate across multiple AWS regions and accounts, allowing you to snapshot development, QA, pre-production, and production workloads with the same process. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## IAM permissions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| For Kosli Capture to snapshot your environment, you must grant a set of read-only permissions. Kosli's CloudFormation template lists these. The permissions are typically "Describe" or "List" permissions. The [Kosli Capture Security](/administration/kosli_capture/security) page provides a deep-diver into the structure of the permissions needed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The IAM role created in your environment includes a trust policy that allows Kosli Capture to assume the role. The trust policy limits access to the AWS account in which Kosli Capture is running. Furthermore, the trust policy includes an external ID that acts as a shared secret between Kosli and you, so that only access from Kosli Capture is permitted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The external ID (shared secret) is securely stored with Kosli Capture. Kosli's internal IAM permissions ensure that the secret can only be accessed by the specific instance of Kosli Capture worker that is operating for you. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+48
to
+54
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — with the pages now split, this section and 6e1d5c5 gave Kosli Capture its own folder with Worth deciding what each page owns. A reasonable split: the overview says what access is needed and why it is safe in two or three sentences, and the security page owns the mechanism. Right now the only link between them is buried at the end of line 69, and Two things on line 69 itself: "deep-diver" should be "deep dive", and there is a double space before "The".
Suggested change
Comment on lines
+48
to
+54
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion — now that the pages are split, decide which one owns the trust policy. 6e1d5c5 gave Kosli Capture its own folder with A reasonable split: the overview says in two sentences what access is needed and why it is safe, and Two things on line 48 itself: "deep-diver" should be "deep dive", and there is a double space before "The".
Suggested change
Comment on lines
+48
to
+54
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — now that the pages are split, decide which one owns the trust policy. 6e1d5c5 gave Kosli Capture its own folder with A workable split: the overview says in two sentences what access is needed and why it is safe, and Line 50 also has "deep-diver" for "deep dive", and a double space before "The".
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,102 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| title: Kosli Capture - Security | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sidebarTitle: Security | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: "Learn about the security of Kosli Capture" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tag: "ALPHA" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| </Warning> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Kosli capture permissions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The Kosli Capture managed service uses the public AWS, GCP and Azure 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — GCP and Azure are claimed here but nowhere else, and "supported resources" is now undefined. This sentence says Kosli Capture "uses the public AWS, GCP and Azure APIs", but the rest of this page is AWS-only (IAM role, CloudFormation, ECS/Lambda/S3 statements), and This got worse when the "Current status" section was dropped from Suggest scoping this sentence to what exists today and naming the supported resource types on the main page (or restoring a short scope statement there).
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — GCP and Azure are claimed only here, and the "publicly accessible" template still has no URL. Two problems in one sentence:
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — GCP and Azure are claimed only here, and the "publicly accessible" template still has no URL. Two problems in one sentence:
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — GCP and Azure are claimed only here, and nothing on any of the three pages gives those readers a mechanism. This says Kosli Capture "uses the public AWS, GCP and Azure APIs", but every mechanism described across the new folder is AWS-only: an IAM role, a CloudFormation template, an This became the only provider-scope statement on the site when 7afa53c dropped the
Suggested change
Related, and the reason the scope statement is load-bearing: with
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — GCP and Azure are claimed only here, and no page gives those readers a mechanism. Every mechanism across the folder is AWS-only: an IAM role, a CloudFormation template, an This became the only provider-scope statement on the site when 7afa53c dropped the Second thing in the same sentence: "The template is publicly accessible and can be used directly within an
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The CloudFormation template we share with you includes a "phone-home" feature that notifies Kosli when a CloudFormation stack has been built from it; this allows us to pick up the AWS AccountId for the account in which you have used the CloudFormation template without you needing to do anything. This automation is especially useful when you deploy the template as a StackSet within an Organizational Unit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Assume role | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The IAM role defined within the CloudFormation template includes an "assume role" policy granting permission from Kosli. This appears as: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KosliCaptureAccessRole: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type: AWS::IAM::Role | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Properties: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RoleName: !Ref RoleName | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Description: >- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Read-only access for Kosli Capture SDLC compliance evidence collection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Managed by CloudFormation; do not edit in place. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxSessionDuration: 3600 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AssumeRolePolicyDocument: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Version: "2012-10-17" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Statement: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Sid: AllowKosliToAssumeWithExternalId | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Effect: Allow | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Principal: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AWS: !Ref TrustedPrincipalArn | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Action: sts:AssumeRole | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Condition: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StringEquals: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sts:ExternalId: !Ref ExternalId | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### All permissions needed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The IAM role defined within the Cloudformation template includes a number of IAM policy statements, granting read-only access to some AWS APIs. The statements are: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Statement: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # How Capture finds what to snapshot. Discovery lists the ECS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # clusters in the account and reads each cluster's tags from the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # same DescribeClusters call; those tags are what decide which | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Kosli environment a cluster is reported into. Without | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # ListClusters and DescribeClusters a role created from this | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # template cannot run discovery at all. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Worth knowing for a security review: these are inventory calls | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # and none of them returns application data. DescribeTaskDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # is the widest - a task definition holds the container image, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # command, and any environment variables written into the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # definition itself in plain text. Values injected from Secrets | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Manager or Parameter Store are named there rather than resolved, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # so what comes back is the reference and not the secret. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Sid: EcsInventory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Effect: Allow | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:DescribeCapacityProviders | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:DescribeClusters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:DescribeContainerInstances | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:DescribeServices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:DescribeTaskDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:DescribeTasks | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListClusters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListContainerInstances | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListServices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListTagsForResource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListTaskDefinitionFamilies | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListTaskDefinitions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - ecs:ListTasks | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Resource: "*" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Sid: LambdaInventory | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Effect: Allow | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:GetFunctionConfiguration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:GetPolicy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:ListAliases | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:ListFunctions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:ListTags | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:ListVersionsByFunction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Resource: "*" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # lambda:GetFunction returns a pre-signed URL to the deployment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # package. That is source-code access, so it is denied outright. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Sid: NeverDownloadFunctionCode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Effect: Deny | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Action: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:GetFunction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - lambda:GetLayerVersion | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Resource: "*" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion — closing fence has four backticks, and neither code block declares a language. The four-backtick close does still terminate the block under CommonMark, so it renders — but it's a stray character, and neither block (line 20 and line 46) tags a language, so both lose syntax highlighting on what is otherwise a page of YAML. Change
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — stray fourth backtick, and the S3 removal left the block's framing stale. The closing fence is More substantively: b6dd574 removed the Neither code block declares a language, so both lose highlighting on what is otherwise a page of YAML — change
Suggested change
Comment on lines
+94
to
+102
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion — the S3 removal left this deny unexplained, and the closing fence has four backticks. b6dd574 removed the Also, line 100 closes with
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion — stray fourth backtick, no language tags, and the S3 removal left this deny unexplained. The closing fence is Neither code block on this page declares a language (openers at lines 22 and 48), so a page that is entirely YAML gets no syntax highlighting — worth making both Substantively: b6dd574 removed the
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion — stray fourth backtick, no language tags, and the S3 removal left this deny unexplained. The closing fence here is Neither code block declares a language (openers at lines 22 and 48), so a page that is entirely YAML gets no syntax highlighting — worth making both Substantively: b6dd574 removed the
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -64,6 +64,10 @@ terraform import kosli_environment.my_environment production | |||||||||||||||||||||
| The `type` in your Terraform configuration must exactly match the type of the existing environment in Kosli. A mismatch will cause import errors or misconfiguration. | ||||||||||||||||||||||
| </Warning> | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Automatically creating physical environments | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The [Kosli Capture Managed Service](/administration/kosli_capture/overview) will automatically snapshot your infrastructure according to rules you define. Kosli Capture will create physical environments as needed. | ||||||||||||||||||||||
|
Comment on lines
+67
to
+69
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — "according to rules you define" is stale, and the section sits outside this page's declared scope. Two separate problems:
Present tense also reads better than "will automatically snapshot" / "will create" for a capability that exists today.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Improvement — "according to rules you define" no longer matches the page it links to. 0a1e3f9 removed the user-authored configuration document. At this branch head Two smaller points on the same block: the H3 nesting under "Managing physical environments" is right, but line 13 tells the reader "This page covers managing environments via Terraform", and Kosli Capture is neither Terraform, CLI, nor UI — saying so explicitly stops the section reading as misfiled. And the two sibling H3s are imperative ("Create a physical environment", "Import an existing physical environment"), so a gerund heading stands out.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Managing logical environments | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Logical environments group physical environments into a combined view — useful for representing a full production tier across multiple runtimes. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -72,7 +72,15 @@ | |||||||||||||||||||
| "administration/managing_custom_attestation_types/overview" | ||||||||||||||||||||
| ] | ||||||||||||||||||||
| }, | ||||||||||||||||||||
| "administration/managing_tags" | ||||||||||||||||||||
| "administration/managing_tags", | ||||||||||||||||||||
| { | ||||||||||||||||||||
| "group": "Kosli Capture", | ||||||||||||||||||||
| "pages": [ | ||||||||||||||||||||
| "administration/kosli_capture/overview", | ||||||||||||||||||||
| "administration/kosli_capture/getting_started", | ||||||||||||||||||||
| "administration/kosli_capture/security" | ||||||||||||||||||||
| ] | ||||||||||||||||||||
|
Comment on lines
+78
to
+82
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Critical — Worth deciding placement rather than just appending it. Two smaller things while you are in here:
Suggested change
|
||||||||||||||||||||
| } | ||||||||||||||||||||
| ] | ||||||||||||||||||||
| }, | ||||||||||||||||||||
| { | ||||||||||||||||||||
|
|
||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Critical — the first paragraph tells the reader to prepare something the page never asks for.
"provide configuration details for how your tags should map to environments within Kosli" is contradicted three ways at this branch head:
overview.md:20says you configure Kosli Capture "by activating it for different AWS services", and that it "uses details about your infrastructure, such as the name of an ECS cluster, to build environments" — names, not a tag map.kosli.capture=falseexclusion tag at line 43 — filtering, not mapping.This is the tag-mapping configuration document that 0a1e3f9 removed; the intro was not updated with it. Being the opening sentence of the only how-to page in the group, it is the sentence most likely to be acted on.