Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gclouduniverse/managed-environments
Managed environments pipeline for CAIP Notebooks
https://github.com/gclouduniverse/managed-environments
Last synced: 5 days ago
JSON representation
Managed environments pipeline for CAIP Notebooks
- Host: GitHub
- URL: https://github.com/gclouduniverse/managed-environments
- Owner: gclouduniverse
- License: apache-2.0
- Created: 2020-11-04T01:04:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-08T17:08:59.000Z (about 3 years ago)
- Last Synced: 2024-05-28T15:16:30.336Z (7 months ago)
- Language: Shell
- Size: 28.3 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Managing upgrades and dependencies for Vertex AI Workbench user-managed notebooks
Sample [Cloud Build][cloud-build] pipelines for
[Vertex AI Workbench user-managed notebooks][vaiw-notebooks] upgrades and dependency management.
## How-to use
0 - Prepare:
* Clone this repository.
* Choose a [Deep Learning Container (DLCs)][dlc] image and specifiy it in the [Dockerfile](Dockerfile)
* Add notebook dependencies to the [Dockerfile](Dockerfile).
* Add notebooks for automated testing in folder [test_notebooks](test_notebooks)
* Specify an `_IMAGE_NAME` in each of of the pipeline yaml files.
1 - Publish staging image:
* Create a [trigger][trigger] to run the [staging pipeline](cloudbuild-staging.yaml)
on each commit to branch called `staging`.
* Commit into to the `staging` branch and push to your own remote repository.
* Cloud Build automatically runs the [test_notebooks](test_notebooks)
and creates the staging image.
2 - Test staging image
* (Optional) [Create notebook instances][gc-nb-instances-create] to manually test image
using the `staging` environment.
```sh
gcloud notebooks instances create \
--location= \
--environment=.staging
```
* Access your instance from the [Vertex AI Workbench console][vaiw-console]
3 - Publish production image:
* Create a [trigger][trigger] to run the [production pipeline](cloudbuild-prod.yaml)
on each commit to a branch called `production`.
* Commit into the `production` branch and push to your own remote repository.
* Cloud Build creates the production image.
4 - [Create notebook instances][gc-nb-instances-create] using image from the `production`
environment
```sh
gcloud notebooks instances create \
--location= \
--environment=.production
```
* Access your instance from the [Vertex AI Workbench console][vaiw-console]
Both pipelines use the original [commit SHA][sha] as the [Docker tag][docker-tag],
representing the [image version ID][image-version] in [Container Registry][container-registry].
## Licensing
```lang-none
Copyright 2021 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.
```
## Contributing
* [Contributing guidelines](contributing-guidelines.md)
* [Code of conduct](code-of-conduct.md)
[vaiw-console]: https://console.cloud.google.com/vertex-ai/workbench/list/instances
[vaiw-notebooks]: https://cloud.google.com/vertex-ai/docs/workbench/
[cloud-build]: https://cloud.google.com/build
[container-registry]: https://cloud.google.com/container-registry
[dlc]: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
[docker-tag]: https://docs.docker.com/engine/reference/commandline/tag/
[gc-nb-instances-create]: https://cloud.google.com/sdk/gcloud/reference/notebooks/instances/create
[image-version]: https://cloud.google.com/container-registry/docs/managing#listing_the_versions_of_an_image
[sha]: https://git-scm.com/book/en/v2/Git-Internals-Git-Objects
[trigger]: https://cloud.google.com/build/docs/automating-builds/create-manage-triggers