Skip to content
Snippets Groups Projects
Unverified Commit cbbcceb3 authored by marciocloudflare's avatar marciocloudflare Committed by GitHub
Browse files

[Images] Sourcing kit (#6244)


* created sourcing kit folder
changed page weights

* created pages and content

* added tag beta to title

* refined amazon credentials text

* refined edit page

* refined enable page

* refined text

* refined text enabling sk

* refined text edit sk

* refined text enable sk

* added import jobs page

* changed credentials file name
refined text
deleted import jobs

* added beta note and links

* refined text

* corrected link

* Apply suggestions from code review

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update content/images/cloudflare-images/sourcing-kit/enable-sourcing-kit.md

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* corrected api file name
changed file names edit enable
corrected links and text

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>
parent 8faa5b68
No related branches found
No related tags found
No related merge requests found
......@@ -2,7 +2,7 @@
pcx_content_type: navigation
title: API reference
external_link: https://api.cloudflare.com/#cloudflare-images-properties
weight: 11
weight: 12
_build:
publishResources: false
render: never
......
---
pcx_content_type: how-to
title: Analytics
weight: 9
weight: 10
meta:
title: Images analytics
---
......
---
pcx_content_type: reference
title: Make an image private
weight: 8
weight: 9
---
# Make an image private
......
---
pcx_content_type: concept
title: Sourcing Kit (beta)
weight: 8
layout: single
---
{{<beta>}}Sourcing Kit{{</beta>}}
With Sourcing Kit you can define one or multiple repositories of images to bulk import from Amazon S3. Once you have these set up, you can reuse those sources and import only new images to your Cloudflare Images account. This helps you make sure that only usable images are imported, and skip any other objects or files that might exist in that source.
Sourcing Kit also lets you target paths, define prefixes for imported images, and obtain error logs for bulk operations.
Sourcing Kit is available in beta. If you have any comments, questions, or bugs to report, contact the Images team on our [Discord channel](https://discord.com/channels/595317990191398933/973591562615390228). You can also engage with other users and the Images team on Cloudflare's [support forum](https://community.cloudflare.com/c/developers/images/63).
\ No newline at end of file
---
pcx_content_type: how-to
title: Credentials
weight: 3
---
# Amazon S3 credentials
To migrate images from Amazon S3, Sourcing Kit requires access permissions to your bucket. While you can use any AWS Identity and Access Management (IAM) user credentials with the correct permissions to create a Sourcing Kit source, Cloudflare recommends that you create a user with a narrow set of permissions.
To create the correct Sourcing Kit permissions:
1. Log in to your AWS IAM account.
2. Create a policy with the following format (replace `<BUCKET_NAME>` with the bucket you want to grant access to):
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:Get*",
"s3:List*"
],
"Resource": [
"arn:aws:s3:::<BUCKET_NAME>",
"arn:aws:s3:::<BUCKET_NAME>/*"
]
}
]
}
```
3. Next, create a new user and attach the created policy to that user.
You can now use both the Access Key ID and Secret Access Key to create a new source in Sourcing Kit. Refer to [Enable Sourcing Kit](/images/cloudflare-images/sourcing-kit/enable/) to learn more.
---
pcx_content_type: how-to
title: Edit sources
weight: 2
---
# Edit source details
The Sourcing Kit main page has a list of all the import jobs and sources you have defined. This is where you can edit details for your sources or abort running import jobs.
## Source details
You can learn more about your sources by selecting the **Sources** tab on the Sourcing Kit dashboard. Use this option to rename or delete your sources.
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account.
2. Go to **Images** > **Sourcing Kit**.
3. Select **Sources** and choose the source you want to change.
4. In this page you have the option to rename or delete your source. Select **Rename source** or **Delete source** depending on what you want to do.
## Abort import jobs
While Cloudflare Images is still running a job to import images into your account, you can abort it before it finishes.
1. Log in to the [ Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account.
2. Go to **Images** > **Sourcing Kit**.
3. In **Imports** select the import job you want to abort.
4. The next page shows you a summary of the import. Select **Abort**.
5. Confirm that you want to abort your import job by selecting **Abort** on the dialog box.
\ No newline at end of file
---
pcx_content_type: how-to
title: Enable Sourcing Kit
weight: 1
---
# Enable Sourcing Kit
Enabling Sourcing Kit will set it up with the necessary information to start importing images from your Amazon S3 account.
## Create your first import job
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account.
2. Go to **Images** > **Sourcing Kit**.
3. Select **Import images** to create an import job.
4. In **Source name** give your source an appropriate name.
5. In **Amazon S3 bucket information** enter the S3's bucket name where your images are stored.
6. In **Required credentials**, enter your Amazon S3 credentials. This is required to connect Cloudflare Images to your source and import your images. Refer to [Credentials](/images/cloudflare-images/sourcing-kit/credentials/) to learn more about how to set up credentials.
7. Select **Next**.
8. In **Basic rules** define the Amazon S3 path to import your images from, and the path you want to copy your images to in your Cloudflare Images account. This is optional, and you can leave these fields blank.
9. On the same page, in **Overwrite images**, you need to choose what happens when the files in your source change. The recommended action is to copy the new images and overwrite the old ones on your Cloudflare Images account. You can also choose to skip the import, and keep what you already have on your Cloudflare Images account.
10. Select **Next**.
11. Review and confirm the information regarding the import job you created. Select **Start importing** to start importing images from your source.
Your import job is now created. You can review the job status on the Sourcing Kit main page. It will show you information such as how many objects it found, how many images were imported, and any errors that might have occurred.
{{<Aside type="note">}}
Sourcing Kit will warn you when you are about to reach the limit for your plan space quota. When you exhaust the space available in your plan, the importing jobs will be aborted. If you see this warning on Sourcing Kit’s main page, select **View plan** to change your plan’s limits.
{{</Aside>}}
## Define a new source
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account.
2. Go to **Images** > **Sourcing Kit**.
3. Select **Import images** > **Define a new source**.
Repeat steps 4-11 in [Create your first import job](#create-your-first-import-job) to finish setting up your new source.
## Define additional import jobs
You can have many import jobs from the same or different sources. If you select an existing source to create a new import job, you will not need to enter your credentials again.
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account.
2. Go to **Images** > **Sourcing Kit**.
3. Select **Import images**.
4. Choose from one of the sources already configured.
Repeat steps 8-11 in [Create your first import job](#create-your-first-import-job) to finish setting up your new import job.
## Next steps
Refer to [Edit source details](/images/cloudflare-images/sourcing-kit/edit/) to learn more about editing details for import jobs you have already created, or to learn how to abort running import jobs.
\ No newline at end of file
......@@ -3,7 +3,7 @@ type: overview
hideChildren: true
pcx_content_type: navigation
title: Tutorials
weight: 10
weight: 11
layout: table
column_text: Type
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment