-
Notifications
You must be signed in to change notification settings - Fork 2k
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
feat(parametermanager): Added samples to create list render parameter and version in specific region #4013
base: main
Are you sure you want to change the base?
feat(parametermanager): Added samples to create list render parameter and version in specific region #4013
Changes from all commits
e1783a2
07b0b97
5a9fd59
06379e0
7ef2508
2bdc515
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,52 @@ | ||
# Copyright 2025 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
name: parametermanager | ||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- 'parametermanager/**' | ||
- '.github/workflows/parametermanager.yaml' | ||
pull_request: | ||
types: | ||
- opened | ||
- reopened | ||
- synchronize | ||
- labeled | ||
paths: | ||
- 'parametermanager/**' | ||
- '.github/workflows/parametermanager.yaml' | ||
schedule: | ||
- cron: '0 0 * * 0' | ||
jobs: | ||
test: | ||
# Ref: https://github.com/google-github-actions/auth#usage | ||
permissions: | ||
contents: 'read' | ||
id-token: 'write' | ||
if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' | ||
uses: ./.github/workflows/test.yaml | ||
with: | ||
name: 'parametermanager' | ||
path: 'parametermanager' | ||
flakybot: | ||
# Ref: https://github.com/google-github-actions/auth#usage | ||
permissions: | ||
contents: 'read' | ||
id-token: 'write' | ||
if: github.event_name == 'schedule' && always() # always() submits logs even if tests fail | ||
uses: ./.github/workflows/flakybot.yaml | ||
needs: [test] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"name": "nodejs-parameter-manager-samples", | ||
"private": true, | ||
"license": "Apache-2.0", | ||
"files": [ | ||
"*.js" | ||
], | ||
"author": "Google LLC", | ||
"repository": "googleapis/nodejs-parameter-manager", | ||
"engines": { | ||
"node": ">=20" | ||
}, | ||
"scripts": { | ||
"test": "c8 mocha --recursive test/ --timeout=800000" | ||
}, | ||
"directories": { | ||
"test": "test" | ||
}, | ||
"dependencies": { | ||
"@google-cloud/parametermanager": "^0.1.0" | ||
}, | ||
"devDependencies": { | ||
"@google-cloud/secret-manager": "^5.6.0", | ||
"c8": "^10.1.3", | ||
"chai": "^4.5.0", | ||
"mocha": "^11.1.0", | ||
"uuid": "^11.0.5" | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
// Copyright 2025 Google LLC | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// https://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
'use strict'; | ||
|
||
/** | ||
* Creates a new version of an existing parameter in the specified region | ||
* of the specified project using the Google Cloud Parameter Manager SDK. | ||
* The payload is specified as a JSON string and includes a reference to a secret. | ||
* | ||
* @param {string} projectId - The Google Cloud project ID where the parameter is to be created. | ||
* @param {string} locationId - The ID of the region where parameter is to be created. | ||
* @param {string} parameterId - The ID of the parameter to create. This ID must be unique within the project location. | ||
*/ | ||
async function main( | ||
projectId = 'my-project', | ||
locationId = 'us-central1', | ||
parameterId = 'my-regional-parameter' | ||
) { | ||
// [START parametermanager_create_regional_param] | ||
/** | ||
* TODO(developer): Uncomment these variables before running the sample. | ||
*/ | ||
// const projectId = 'YOUR_PROJECT_ID'; | ||
// const locationId = 'YOUR_LOCATION_ID'; | ||
// const parameterId = 'YOUR_PARAMETER_ID'; | ||
Comment on lines
+33
to
+37
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. |
||
|
||
// Imports the Parameter Manager library | ||
const {ParameterManagerClient} = require('@google-cloud/parametermanager'); | ||
|
||
// Adding the endpoint to call the regional parameter manager server | ||
const options = { | ||
apiEndpoint: `parametermanager.${locationId}.rep.googleapis.com`, | ||
}; | ||
|
||
// Instantiates a client with regional endpoint | ||
const client = new ParameterManagerClient(options); | ||
|
||
async function createRegionalParam() { | ||
const parent = client.locationPath(projectId, locationId); | ||
const request = { | ||
parent: parent, | ||
parameterId: parameterId, | ||
}; | ||
|
||
const [parameter] = await client.createParameter(request); | ||
console.log(`Created regional parameter: ${parameter.name}`); | ||
} | ||
|
||
await createRegionalParam(); | ||
// [END parametermanager_create_regional_param] | ||
} | ||
|
||
// This sample demonstrates how to create a regional parameter with unstructured data. | ||
const args = process.argv.slice(2); | ||
main(...args).catch(console.error); | ||
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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
// Copyright 2025 Google LLC | ||
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. |
||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// https://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
'use strict'; | ||
|
||
/** | ||
* Creates a new version of an existing parameter in the specified region | ||
* of the specified project using the Google Cloud Parameter Manager SDK. | ||
* The payload is specified as an unformatted string. | ||
* | ||
* @param {string} projectId - The Google Cloud project ID where the parameter is located. | ||
* @param {string} locationId - The ID of the region where parameter is located. | ||
* @param {string} parameterId - The ID of the parameter for which the version is to be created. | ||
* @param {string} parameterVersionId - The ID of the parameter version to be created. | ||
* @param {string} payload - The unformatted string payload to be stored in the parameter version. | ||
*/ | ||
async function main( | ||
projectId = 'my-project', | ||
locationId = 'us-central1', | ||
parameterId = 'my-parameter', | ||
parameterVersionId = 'v1', | ||
payload = 'This is unstructured data' | ||
) { | ||
// [START parametermanager_create_regional_param_version] | ||
/** | ||
* TODO(developer): Uncomment these variables before running the sample. | ||
*/ | ||
// const projectId = 'YOUR_PROJECT_ID'; | ||
// const locationId = 'us-central1'; | ||
// const parameterId = 'YOUR_PARAMETER_ID'; | ||
// const parameterVersionId = 'YOUR_PARAMETER_VERSION_ID'; | ||
// const payload = 'This is unstructured data'; | ||
Comment on lines
+37
to
+43
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. |
||
|
||
// Imports the Parameter Manager library | ||
const {ParameterManagerClient} = require('@google-cloud/parametermanager'); | ||
|
||
// Adding the endpoint to call the regional parameter manager server | ||
const options = { | ||
apiEndpoint: `parametermanager.${locationId}.rep.googleapis.com`, | ||
}; | ||
|
||
// Instantiates a client with regional endpoint | ||
const client = new ParameterManagerClient(options); | ||
|
||
async function createRegionalParamVersion() { | ||
// Construct the parent resource name | ||
const parent = client.parameterPath(projectId, locationId, parameterId); | ||
|
||
// Construct the parameter version | ||
const parameterVersion = { | ||
payload: { | ||
data: Buffer.from(payload, 'utf8'), | ||
}, | ||
}; | ||
|
||
// Construct the request | ||
const request = { | ||
parent: parent, | ||
parameterVersionId: parameterVersionId, | ||
parameterVersion: parameterVersion, | ||
}; | ||
|
||
// Create the parameter version | ||
const [response] = await client.createParameterVersion(request); | ||
console.log(`Created regional parameter version: ${response.name}`); | ||
} | ||
|
||
await createRegionalParamVersion(); | ||
// [END parametermanager_create_regional_param_version] | ||
} | ||
|
||
// Parse command line arguments | ||
const args = process.argv.slice(2); | ||
main(...args).catch(console.error); | ||
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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
// Copyright 2025 Google LLC | ||
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. |
||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// https://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
'use strict'; | ||
|
||
/** | ||
* Creates a new version of an existing parameter in the specified region | ||
* of the specified project using the Google Cloud Parameter Manager SDK. | ||
* The payload is specified as a JSON string and includes a reference to a secret. | ||
* | ||
* @param {string} projectId - The Google Cloud project ID where the parameter is located. | ||
* @param {string} locationId - The ID of the region where parameter is located. | ||
* @param {string} parameterId - The ID of the parameter for which the version is to be created. | ||
* @param {string} parameterVersionId - The ID of the parameter version to be created. | ||
* @param {string} secretId - The ID of the secret to be referenced. | ||
*/ | ||
async function main( | ||
projectId = 'my-project', | ||
locationId = 'us-central1', | ||
parameterId = 'my-parameter', | ||
parameterVersionId = 'v1', | ||
secretId = 'projects/my-project/secrets/application-secret/version/latest' | ||
) { | ||
// [START parametermanager_create_regional_param_version_with_secret] | ||
/** | ||
* TODO(developer): Uncomment these variables before running the sample. | ||
*/ | ||
// const projectId = 'YOUR_PROJECT_ID'; | ||
// const locationId = 'us-central1'; | ||
// const parameterId = 'YOUR_PARAMETER_ID'; | ||
// const parameterVersionId = 'YOUR_PARAMETER_VERSION_ID'; | ||
// const secretId = 'YOUR_SECRET_ID'; // For example projects/my-project/secrets/application-secret/version/latest | ||
Comment on lines
+37
to
+43
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. |
||
|
||
// Imports the Parameter Manager library | ||
const {ParameterManagerClient} = require('@google-cloud/parametermanager'); | ||
|
||
// Adding the endpoint to call the regional parameter manager server | ||
const options = { | ||
apiEndpoint: `parametermanager.${locationId}.rep.googleapis.com`, | ||
}; | ||
|
||
// Instantiates a client with regional endpoint | ||
const client = new ParameterManagerClient(options); | ||
|
||
async function createRegionalParamVersionWithSecret() { | ||
// Construct the parent resource name | ||
const parent = client.parameterPath(projectId, locationId, parameterId); | ||
|
||
// Construct the payload JSON data with secret references | ||
const payloadData = { | ||
db_user: 'test_user', | ||
db_password: `__REF__("//secretmanager.googleapis.com/${secretId}")`, | ||
}; | ||
|
||
// Construct the parameter version | ||
const parameterVersion = { | ||
payload: { | ||
data: Buffer.from(JSON.stringify(payloadData), 'utf8'), | ||
}, | ||
}; | ||
|
||
// Construct the request | ||
const request = { | ||
parent: parent, | ||
parameterVersionId: parameterVersionId, | ||
parameterVersion: parameterVersion, | ||
}; | ||
|
||
// Create the regional parameter version | ||
const [response] = await client.createParameterVersion(request); | ||
console.log( | ||
`Created regional parameter version with secret: ${response.name}` | ||
); | ||
} | ||
|
||
await createRegionalParamVersionWithSecret(); | ||
// [END parametermanager_create_regional_param_version_with_secret] | ||
} | ||
|
||
// Parse command line arguments | ||
const args = process.argv.slice(2); | ||
main(...args).catch(console.error); | ||
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. |
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.
The copyright year is set to 2025. Please confirm that this is the correct year.