From 06a1cc53a4c653ff29f2b17bb7deba58e18c4de9 Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Thu, 16 May 2019 01:52:53 -0400 Subject: [PATCH 1/2] Update README.md --- cmd/api/README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/cmd/api/README.md b/cmd/api/README.md index daab582..2735684 100644 --- a/cmd/api/README.md +++ b/cmd/api/README.md @@ -1,4 +1,14 @@ -First, be in a local directory containing buildpack-detectable source: +## What is this? + +An experimental GCB API-compatible buildpack service running on Cloud Run. A GCB +user can use any revently released `gcloud` along with this service to upload +and build buildpack-compatible source and produce a container image. + +This is **an experiment** and should absolutely not be used for anything serious. + +## How do I use it? + +First, get into a local directory containing buildpack-detectable source: ``` $ git clone git@github.com:buildpack/sample-java-app.git @@ -53,14 +63,16 @@ statusDetail: '' - [ ] Builds are performed entirely in the context of the `projects.builds.create` request, not by polling a long-running operation. + The `--async` flag has no effect. - [ ] Build operations (source pulls and image pushes) are authorized using the end-user credentials, not the project's builder service account. - [ ] Build logs are not yet written to Cloud Storage, so they're not available via `gcloud`. -- [ ] Timing is not collected or reported. +- [ ] `timing` is not collected or reported. - [ ] `timeout` is not configurable. If Cloud Run request times out, client gets a 502. -- [ ] `sourceProvenance` is not yet collected or reported. +- [ ] `sourceProvenance` is not yet collected or reported, or uploaded to a + Grafeas instance. - [ ] `projects.builds.list` is not yet implemented. - [ ] `operations.get` and `operations.list` are not yet implemented. - [ ] `projects.builds.cancel` is not implementable (the client doesn't get the From 486e4d5ae081c7071688a9eb0b76eec7f7dc8a50 Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Thu, 16 May 2019 01:55:45 -0400 Subject: [PATCH 2/2] Update README.md --- cmd/api/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/cmd/api/README.md b/cmd/api/README.md index 2735684..2092a43 100644 --- a/cmd/api/README.md +++ b/cmd/api/README.md @@ -1,9 +1,13 @@ ## What is this? An experimental GCB API-compatible buildpack service running on Cloud Run. A GCB -user can use any revently released `gcloud` along with this service to upload +user can use any recently released `gcloud` along with this service to upload and build buildpack-compatible source and produce a container image. +Any requested `steps` are ignored and a buildpack build is executed on the +source instead. The request must specify exactly one image to build in `images`, +and must specify a `storageSource`. + This is **an experiment** and should absolutely not be used for anything serious. ## How do I use it? @@ -15,8 +19,8 @@ $ git clone git@github.com:buildpack/sample-java-app.git $ cd sample-java-app ``` -Then, by overriding the address where API requests are sent, you can create -Build requests that execute buildpacks builds: +Then, by using `gcloud` and overriding the address where API requests are sent, +you can create Build requests that execute buildpacks builds: ``` $ CLOUDSDK_API_ENDPOINT_OVERRIDES_CLOUDBUILD=https://api-an3qnndwmq-uc.a.run.app/ gcloud builds submit --tag=gcr.io/my-project/built