Skip to content

Commit 0c35feb

Browse files
authored
docs(secretmanager): Added sample for creating Secret with UserManaged replication (GoogleCloudPlatform#1664)
1 parent dc9256b commit 0c35feb

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<?php
2+
/*
3+
* Copyright 2022 Google LLC.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
/*
19+
* For instructions on how to run the full sample:
20+
*
21+
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/secretmanager/README.md
22+
*/
23+
24+
declare(strict_types=1);
25+
26+
namespace Google\Cloud\Samples\SecretManager;
27+
28+
// Import the Secret Manager client library.
29+
use Google\Cloud\SecretManager\V1\Replication;
30+
use Google\Cloud\SecretManager\V1\Replication\UserManaged;
31+
use Google\Cloud\SecretManager\V1\Replication\UserManaged\Replica;
32+
use Google\Cloud\SecretManager\V1\Secret;
33+
use Google\Cloud\SecretManager\V1\SecretManagerServiceClient;
34+
35+
/**
36+
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
37+
* @param string $secretId Your secret ID (e.g. 'my-secret')
38+
* @param array $locations Replication locations (e.g. array('us-east1', 'us-east4'))
39+
*/
40+
function create_secret_with_user_managed_replication(string $projectId, string $secretId, array $locations): void
41+
{
42+
// Create the Secret Manager client.
43+
$client = new SecretManagerServiceClient();
44+
45+
// Build the resource name of the parent project.
46+
$parent = $client->projectName($projectId);
47+
48+
$replicas = [];
49+
foreach ($locations as $location) {
50+
$replicas[] = new Replica(['location' => $location]);
51+
}
52+
53+
$secret = new Secret([
54+
'replication' => new Replication([
55+
'user_managed' => new UserManaged([
56+
'replicas' => $replicas
57+
]),
58+
]),
59+
]);
60+
61+
// Create the secret.
62+
$secret = $client->createSecret($parent, $secretId, $secret);
63+
64+
// Print the new secret name.
65+
printf('Created secret: %s', $secret->getName());
66+
}
67+
68+
// The following 2 lines are only needed to execute the samples on the CLI
69+
require_once __DIR__ . '/../../testing/sample_helpers.php';
70+
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

secretmanager/test/secretmanagerTest.php

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ class secretmanagerTest extends TestCase
3838
private static $testSecretToDelete;
3939
private static $testSecretWithVersions;
4040
private static $testSecretToCreateName;
41+
private static $testUmmrSecretToCreateName;
4142
private static $testSecretVersion;
4243
private static $testSecretVersionToDestroy;
4344
private static $testSecretVersionToDisable;
@@ -53,6 +54,7 @@ public static function setUpBeforeClass(): void
5354
self::$testSecretToDelete = self::createSecret();
5455
self::$testSecretWithVersions = self::createSecret();
5556
self::$testSecretToCreateName = self::$client->secretName(self::$projectId, self::randomSecretId());
57+
self::$testUmmrSecretToCreateName = self::$client->secretName(self::$projectId, self::randomSecretId());
5658

5759
self::$testSecretVersion = self::addSecretVersion(self::$testSecretWithVersions);
5860
self::$testSecretVersionToDestroy = self::addSecretVersion(self::$testSecretWithVersions);
@@ -67,6 +69,7 @@ public static function tearDownAfterClass(): void
6769
self::deleteSecret(self::$testSecretToDelete->getName());
6870
self::deleteSecret(self::$testSecretWithVersions->getName());
6971
self::deleteSecret(self::$testSecretToCreateName);
72+
self::deleteSecret(self::$testUmmrSecretToCreateName);
7073
}
7174

7275
private static function randomSecretId(): string
@@ -148,6 +151,19 @@ public function testCreateSecret()
148151
$this->assertStringContainsString('Created secret', $output);
149152
}
150153

154+
public function testCreateSecretWithUserManagedReplication()
155+
{
156+
$name = self::$client->parseName(self::$testUmmrSecretToCreateName);
157+
158+
$output = $this->runFunctionSnippet('create_secret_with_user_managed_replication', [
159+
$name['project'],
160+
$name['secret'],
161+
'us-east1,us-east4,us-west1',
162+
]);
163+
164+
$this->assertStringContainsString('Created secret', $output);
165+
}
166+
151167
public function testDeleteSecret()
152168
{
153169
$name = self::$client->parseName(self::$testSecretToDelete->getName());

0 commit comments

Comments
 (0)