此页面由 Cloud Translation API 翻译。

安排备份

本教程介绍如何使用 Cloud Scheduler 和 Cloud Run 函数为 Filestore 实例安排备份。

目标

为 Cloud Scheduler 创建一个具有调用 Cloud Run 函数所需的凭据。
为 Cloud Run 函数创建一个客户端服务账号，该服务账号具有来调用 Filestore 端点。
创建一个 Cloud Run 函数函数来创建 Filestore 实例。
创建一个用于删除 Filestore 实例备份的 Cloud Run functions 函数。
创建一个定期运行任一函数的 Cloud Scheduler 作业。

费用

在本文档中，您将使用 Google Cloud 的以下收费组件：

您可使用价格计算器根据您的预计使用情况来估算费用。 Google Cloud 新用户可能有资格申请免费试用。

准备工作

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Artifact Registry, Cloud Build, Filestore, Cloud Run functions, Cloud Logging, Pub/Sub, Cloud Run, and Cloud Scheduler APIs.

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Artifact Registry, Cloud Build, Filestore, Cloud Run functions, Cloud Logging, Pub/Sub, Cloud Run, and Cloud Scheduler APIs.

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

如果您的项目中没有 Filestore 实例，则必须先创建一个 Filestore 实例。

为 Cloud Scheduler 和 Cloud Run 函数创建客户端服务账号

如果您尚未在 Google Cloud 控制台中点击 激活 Cloud Shell。
创建一个用于运行 Cloud Scheduler 的客户端服务账号调用 Cloud Run 函数函数。在此示例中，请使用 iam service-accounts create 命令将账号命名为 schedulerunner，并将显示名称设置为“FS Backups-Scheduler 的服务账号”：
```
gcloud iam service-accounts create schedulerunner \
    --display-name="Service Account for FS Backups-Scheduler"
```

创建一个 Cloud Run 函数运行身份用以调用 Filestore 端点的客户端服务账号。在此示例中，我们将账号命名为 backupagent，并将显示名设置为“FS Backups-GCF 的服务账号”：

gcloud iam service-accounts create backupagent \
    --display-name="Service Account for FS Backups-GCF"

您可以通过运行 iam service-accounts list 命令来检查是否已创建服务账号：

gcloud iam service-accounts list

该命令会返回如下内容：

NAME                                         EMAIL                                                   DISABLED
Service Account for FS Backups-GCF           backupagent@$PROJECT_ID.iam.gserviceaccount.com         False
Service Account for FS Backups-Scheduler     schedulerunner@$PROJECT_ID.iam.gserviceaccount.com      False

设置环境变量

在本地环境中设置以下环境变量：

Google Cloud 项目 ID 和项目：

export PROJECT_ID=`gcloud config get-value core/project`
export PROJECT_NUMBER=`gcloud projects describe $PROJECT_ID --format="value(projectNumber)"`

Cloud Scheduler 服务代理以及 Cloud Scheduler 和 Cloud Run 函数的客户端服务账号：
```
export SCHEDULER_SA=service-$PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com
export SCHEDULER_CLIENT_SA=schedulerunner@$PROJECT_ID.iam.gserviceaccount.com
export GCF_CLIENT_SA=backupagent@$PROJECT_ID.iam.gserviceaccount.com
```
注意：在某些情况下，您可能需要手动将 Cloud Scheduler Service Agent 角色添加到 Cloud Scheduler 服务账号。仅在启用了 Cloud Scheduler API 的情况下，才需要执行此操作 2019 年 3 月 19 日之前，或者如果您移除了 Cloud Scheduler， Service Agent 角色。如需了解详情，请参阅手动将 Cloud Scheduler Service Agent 角色添加到 Cloud Scheduler 服务账号。
您的 Filestore 实例：
```
export SOURCE_INSTANCE_LOCATION=fs-location
export SOURCE_INSTANCE_NAME=instance-id
export SHARE_NAME=file-share-name
```
替换以下内容：
- 将 fs-location 替换为来源 Filestore 实例所在的可用区或区域。
- 将 instance-id 替换为来源 Filestore 的实例 ID 实例。
- 将 file-share-name 替换为您为从实例提供的 NFS 文件共享所指定的名称。
为 Filestore 备份设置环境变量：
```
export BACKUP_REGION=backup-region
```
将 backup-region 替换为要存储备份的区域。

创建用于创建备份的函数

在 Google Cloud 控制台中，前往 Cloud Run 函数页面。

转到“Cloud Run 函数”页面
点击创建函数并按如下所示配置函数：
- 基础配置：
  - 环境：在本例中，选择 2nd gen，即默认值。
  - 函数名称：在此示例中，我们将函数命名为 fsbackup。
  - 地区：对于本示例，请选择 us-central1。
- 触发器：
  - 触发器类型：从菜单中选择 HTTPS。
  - 鉴别：选择 Require authentication。
- 运行时、构建、连接和安全设置：
  - 运行时 >运行时服务账号 >服务账号：选择 Service Account for FS Backups-GCF（backupagent@$PROJECT_ID.iam.gserviceaccount.com）。
  - 连接 >入站流量设置：选择 Allow all traffic。

点击 Next，然后继续按以下方式进行配置：

运行时：选择 Python 3.8 或更高版本完全受 Cloud Run 函数的支持。
源代码：Inline editor。
入口点：输入 create_backup。
将以下依赖项添加到您的 requirements.txt 文件中：
```
google-auth==2.29.0
requests==2.31.0
```
根据您的用例，您可能需要指定其他依赖项及其对应的版本号。如需了解详情，请参阅预安装的软件包。

使用内嵌编辑器将以下 Python 代码示例复制到 main.py 文件中：

创建备份

此代码示例会创建一个名为 mybackup- 的备份，并在其后附加创建时间。

PROJECT_ID = 'project-id'
SOURCE_INSTANCE_LOCATION = 'fs-location'
SOURCE_INSTANCE_NAME = 'instance-id'
SOURCE_FILE_SHARE_NAME = 'file-share-name'
BACKUP_REGION = 'backup-region'

import google.auth
import google.auth.transport.requests
from google.auth.transport.requests import AuthorizedSession
import time
import requests
import json

credentials, project = google.auth.default()
request = google.auth.transport.requests.Request()
credentials.refresh(request)
authed_session = AuthorizedSession(credentials)

def get_backup_id():
    return "mybackup-" + time.strftime("%Y%m%d-%H%M%S")

def create_backup(request):
    trigger_run_url = "https://file.googleapis.com/v1/projects/{}/locations/{}/backups?backupId={}".format(PROJECT_ID, BACKUP_REGION, get_backup_id())
    headers = {
      'Content-Type': 'application/json'
    }
    post_data = {
      "description": "my new backup",
      "source_instance": "projects/{}/locations/{}/instances/{}".format(PROJECT_ID, SOURCE_INSTANCE_LOCATION, SOURCE_INSTANCE_NAME),
      "source_file_share": "{}".format(SOURCE_FILE_SHARE_NAME)
    }
    print("Making a request to " + trigger_run_url)
    r = authed_session.post(url=trigger_run_url, headers=headers, data=json.dumps(post_data))
    data = r.json()
    print(data)
    if r.status_code == requests.codes.ok:
      print(str(r.status_code) + ": The backup is uploading in the background.")
    else:
      raise RuntimeError(data['error'])
    return "Backup creation has begun!"

替换以下内容：

将 project-id 替换为来源 Filestore 实例。
将 fs-location 替换为来源的可用区或区域 Filestore 实例。
将 instance-id 替换为来源 Filestore 实例的名称。
将 file-share-name 替换为文件共享的名称。
将 backup-region 替换为存储备份的地区。

点击测试函数。

Cloud Shell 中会打开一个新的标签页会话。在该代码中，以下代码消息：
```
Function is ready to test.
```
点击部署并等待部署完成。
切换回上一个 Cloud Shell 标签页。

删除备份

此代码示例会删除早于预定义时段的备份。

您一次只能删除一个来源实例的备份。如需了解详情，请参阅备份。

按照您用来创建 Cloud Storage 存储分区中请使用以下修改创建备份：

函数名称：deletefsbackup。
入口点：delete_backup。

PROJECT_ID = 'project-id'
BACKUP_REGION = 'region'
BACKUP_RETENTION_TIME_HRS = hours

import google.auth
import google.auth.transport.requests
from google.auth.transport.requests import AuthorizedSession
import time
import requests
import json

credentials, project = google.auth.default()
request = google.auth.transport.requests.Request()
credentials.refresh(request)
authed_session = AuthorizedSession(credentials)

retention_seconds = BACKUP_RETENTION_TIME_HRS * 60 * 60

def delete_backup(request):
    now = time.time()
    backup_list = []
    trigger_run_url = "https://file.googleapis.com/v1/projects/{}/locations/{}/backups".format(PROJECT_ID, BACKUP_REGION)
    r = authed_session.get(trigger_run_url)
    data = r.json()
    if not data:
        print("No backups to delete.")
        return "No backups to delete."
    else:
        backup_list.extend(data['backups'])
        while "nextPageToken" in data.keys():
            nextPageToken = data['nextPageToken']
            trigger_run_url_next = "https://file.googleapis.com/v1/projects/{}/locations/{}/backups?pageToken={}".format(PROJECT_ID, BACKUP_REGION, nextPageToken)
            r = authed_session.get(trigger_run_url_next)
            data = r.json()
            backup_list.extend(data['backups'])
    for i in backup_list:
        backup_time = i['createTime']
        backup_time = backup_time[:-4]
        backup_time = float(time.mktime(time.strptime(backup_time, "%Y-%m-%dT%H:%M:%S.%f")))
        i['backup_timestamp'] = backup_time
    sorted_backup_list = sorted(backup_list, key=lambda d: d['backup_timestamp'])
    oldest_backup = sorted_backup_list[0]
    if now - oldest_backup['backup_timestamp'] > retention_seconds:
        print(oldest_backup['name'] + " is older than the indicated retention time.")
        r = authed_session.delete("https://file.googleapis.com/v1/{}".format(oldest_backup['name']))
        data = r.json()
        print(data)
        if r.status_code == requests.codes.ok:
            print(str(r.status_code) + ": Deleting " + oldest_backup['name'] + " in the background.")
        else:
            raise RuntimeError(data['error'])
        return "Backup deletion has begun!"
    return "All backups are within the indicated retention period."

替换以下内容：

将 project-id 替换为备份的 Google Cloud 项目 ID。
将 region 替换为备份所在的地区。备份、调度器作业和函数都应位于同一位置。
将 hours 替换为保留备份的小时数。例如，如果您要将备份保留 10 天，请输入 240。

将 IAM 角色分配给客户端服务账号

将 Cloud Scheduler 服务代理添加到 IAM 具有该角色的 Cloud Scheduler 客户端服务账号的政策共 roles/cloudscheduler.serviceAgent 页。这让服务代理可以模拟客户端服务账号以调用函数会创建备份运行 iam service-accounts add-iam-policy-binding 命令：
```
gcloud iam service-accounts add-iam-policy-binding $SCHEDULER_CLIENT_SA \
    --member=serviceAccount:$SCHEDULER_SA \
    --role=roles/cloudscheduler.serviceAgent
```
为 Cloud Run 函数的客户端服务账号授予 roles/file.editor 角色，以便它可以调用 Filestore 端点。运行 projects add-iam-policy-binding 命令：
```
gcloud projects add-iam-policy-binding $PROJECT_ID \
    --member=serviceAccount:$GCF_CLIENT_SA \
    --role=roles/file.editor
```
向 Cloud Scheduler 的客户端服务账号授予您要使用的函数的 roles/cloudfunctions.invoker 角色。运行以下 functions add-iam-policy-binding 命令：
创建备份
```
gcloud functions add-iam-policy-binding fsbackup \
    --member serviceAccount:$SCHEDULER_CLIENT_SA \
    --role roles/cloudfunctions.invoker
```
系统会显示一条提示，指示您必须在底层 Cloud Run 服务上授予 roles/run.invoker 角色，并且您可以运行 gcloud functions add-invoker-policy-binding 命令来应用该角色。当系统提示您提供回答时，请输入 Y。

现在，只有 Cloud Scheduler 的客户端服务账号可以调用 fsbackup。
删除备份
```
gcloud functions add-iam-policy-binding deletefsbackup \
    --member serviceAccount:$SCHEDULER_CLIENT_SA \
    --role roles/cloudfunctions.invoker
```
系统会显示一条提示，指示您必须在底层 Cloud Run 服务上授予 roles/run.invoker 角色，并且您可以运行 gcloud functions add-invoker-policy-binding 命令来应用该角色。当系统提示您提供回答时，请输入 Y。

现在，只有 Cloud Scheduler 的客户端服务账号可以调用 deletefsbackup。

创建 Cloud Scheduler 作业，以便按指定的时间表触发函数

创建备份

在本教程的示例中，如果您希望每天晚上 10 点安排一次备份，则可以使用 scheduler jobs create http 命令：

gcloud scheduler jobs create http fsbackupschedule \
    --schedule "0 22 * * 1-5" \
    --http-method=GET \
    --uri=https://us-central1-$PROJECT_ID.cloudfunctions.net/fsbackup \
    --oidc-service-account-email=$SCHEDULER_CLIENT_SA    \
    --oidc-token-audience=https://us-central1-$PROJECT_ID.cloudfunctions.net/fsbackup

--schedule 标志用于指定作业的运行频率使用 unix-cron 运行格式。如需了解详情，请参阅配置 Cron 作业时间表。

每个实例每小时最多可以创建 6 个备份。

启动上一步中创建的 Cloud Scheduler 作业。在我们使用 scheduler jobs runs 命令立即运行它：
```
gcloud scheduler jobs run fsbackupschedule
```
fsbackupschedule 作业会立即调用 fsbackup 函数一次您执行了该命令，然后每个工作日晚上 10 点再次调用该命令直到作业暂停为止。
检查 fsbackup 函数的日志以查看它是否执行正确并返回 status 200。

如需在 Google Cloud 控制台中查看日志，请使用日志浏览器：
1. 在 Google Cloud 控制台中，转到 Logs Explorer 页面。
  前往 Logs Explorer
  
  如果您使用搜索栏查找此页面，请选择子标题为 Logging 的结果。
  
  最近的日志会显示在查询结果窗格中。

使用 backups list 命令检查现有备份的状态：

gcloud filestore backups list

该命令会返回类似如下的内容：

NAME                      LOCATION     SRC_INSTANCE                        SRC_FILE_SHARE  STATE
mybackup-20201123-184500  us-central1  us-central1-c/instances/nfs-server  vol1            READY

删除备份

在本教程的示例中，如果要安排操作每个工作日晚上 10 点删除备份，则使用scheduler jobs create http 命令：

gcloud scheduler jobs create http deletefsbackupschedule \
    --schedule "0 22 * * 1-5" \
    --http-method=GET \
    --uri=https://us-central1-$PROJECT_ID.cloudfunctions.net/deletefsbackup \
    --oidc-service-account-email=$SCHEDULER_CLIENT_SA    \
    --oidc-token-audience=https://us-central1-$PROJECT_ID.cloudfunctions.net/deletefsbackup

--schedule 标志用于使用 unix-cron 格式指定作业运行的频率。如需了解详情，请参阅配置 Cron 作业时间表。

与同一源实例关联的备份 delete 操作必须一次一个。如需了解详情，请参阅备份。

启动上一步中创建的 Cloud Scheduler 作业。在我们的我们使用 scheduler jobs runs 命令立即运行它：
```
gcloud scheduler jobs run deletefsbackupschedule
```
deletefsbackupschedule 作业调用 deletefsbackup 函数立即执行一次命令，然后每隔直到作业暂停。
检查 deletefsbackup 函数的日志以查看它是否执行正确并返回 status 200。

如需在 Google Cloud 控制台中查看日志，请使用日志浏览器：
1. 在 Google Cloud 控制台中，转到 Logs Explorer 页面。
  前往 Logs Explorer
  
  如果您使用搜索栏查找此页面，请选择子标题为 Logging 的结果。
  
  最近的日志会显示在查询结果窗格中。

使用 backups list 命令检查现有备份的状态：

gcloud filestore backups list

该命令会返回类似如下的内容：

NAME                      LOCATION     SRC_INSTANCE                        SRC_FILE_SHARE  STATE
mybackup-20201123-184500  us-central1  us-central1-c/instances/nfs-server  vol1            READY

备份配额过低提醒

如果您在安排备份时实施备份配额，可能会用尽备份配额，我们建议您设置备份配额过低提醒。这样，您会在备份配额即将用尽时收到通知。

清理

完成本教程后，您可以清理您创建的资源，让它们停止使用配额，以免产生费用。以下部分介绍如何删除或关闭这些资源。

删除项目

为了避免产生费用，最简单的方法是删除您为本教程创建的项目。

如需删除项目，请执行以下操作：

In the Google Cloud console, go to the Manage resources page.
Go to Manage resources
In the project list, select the project that you want to delete, and then click Delete.
In the dialog, type the project ID, and then click Shut down to delete the project.

安排备份

目标

费用

准备工作

为 Cloud Scheduler 和 Cloud Run 函数创建客户端服务账号

设置环境变量

创建用于创建备份的函数

创建备份

删除备份

将 IAM 角色分配给客户端服务账号

创建备份

删除备份

创建 Cloud Scheduler 作业，以便按指定的时间表触发函数

创建备份

删除备份

备份配额过低提醒

清理

删除项目

后续步骤