doc(configuring-object-storage.md): add section on storing credentials & GCS #68

arschles · 2016-03-05T01:03:09Z

also adds the database component to the list of things that needs S3

…s & GCS also adds the database component to the list of things that needs S3

smothiki · 2016-03-07T18:28:22Z

src/installing-deis/configuring-object-storage.md

+
+As you may know Google Cloud Storage (GCS) can [interoperate with the S3 API](https://cloud.google.com/storage/docs/interoperability), and, if you choose to use Google Cloud Storage for object storage, you'll have to turn on this interoperability mode.
+
+If you choose to use Google Cloud Storage, set your `DEIS_OUTSIDE_STORAGE_HOST` environment variable to `storage.googleapis.com`, and follow [these instructions](https://cloud.google.com/storage/docs/migrating?hl=en_US#keys) to generate an S3 compatible access key ID and access key secret. Store these credentials just as you would if they were AWS S3 or Minio credentials (see the "Storing Credentials" section above).


URL should be along with the scheme http or https
https://github.com/deis/builder/blob/master/pkg/gitreceive/storage/endpoint.go#L25

@smothiki if the URL doesn't have a scheme, then that stripScheme func is a no-op, so it is ok to leave off the scheme.

ok also https://github.com/deis/builder/blob/master/pkg/gitreceive/storage/endpoint.go#L13
its "DEIS_OUTSIDE_STORAGE" there is no HOST

Fixed in 1a0ba70

smothiki · 2016-03-07T18:44:41Z

Builder needs a separate config settings for any endpoint same instructions goes for aws S3 as well.
Also BUCKET is the env variable that needs to be set, bucket names are Global and defaults to "git" which will fail

smothiki · 2016-03-07T18:58:18Z

Please don't merge this until documentation is complete.

bacongobbler · 2016-03-07T18:59:31Z

Also BUCKET is the env variable that needs to be set, bucket names are Global and defaults to "git" which will fail

I think that can be specified elsewhere in another PR since this just addresses S3 credentials.

smothiki · 2016-03-07T19:01:09Z

Builder needs a separate configuration apart from other components in the platform. Also there is an error in the docs, need to set URL scheme as well

arschles · 2016-03-07T21:03:57Z

@smothiki:

Builder needs a separate config settings for any endpoint same instructions goes for aws S3 as well.

I don't understand what you mean here. What is the separate config setting besides DEIS_OUTSIDE_STORAGE_HOST?

Also BUCKET is the env variable that needs to be set, bucket names are Global and defaults to "git" which will fail

Why will git fail?

Builder needs a separate configuration apart from other components in the platform.

Similar to my above comment, can you give more details on what the separate configuration is? IIRC, DEIS_OUTSIDE_STORAGE_HOST and the credentials setup mentioned in these docs is enough.

I've removed the LGTM2 label from this PR until these questions are sorted out.

smothiki · 2016-03-07T22:05:52Z

if there is a git bucket already exists in GCS storage we cannot PUT or GET from the bucket if "git " bucket is not registered under user credentials

smothiki · 2016-03-07T22:08:00Z

Also the code defaults to MInio USER host and PORT . So if user has to set back-end to AWS . He has to do the similar config changes as GCS but it is not documented in this DOC

…UTSIDE_STORAGE_PORT in favor of DEIS_OUTSIDE_STORAGE. also, include examples for outside storage URLs

…he BUCKET env var

arschles · 2016-03-07T23:25:18Z

@smothiki I've added docs for the BUCKET env var in 6cbee9b

arschles · 2016-03-07T23:27:43Z

@smothiki according to https://github.com/deis/builder/blob/master/pkg/gitreceive/storage/endpoint.go#L53-L62, the builder defaults to outside storage. Do my recent changes in arschles@1a0ba70 clearly specify that the DEIS_OUTSIDE_STORAGE env var applies to either S3 or GCS?

smothiki · 2016-03-07T23:51:16Z

I meant deis-builder-rc in deis-dev charts by default doesn't have DEIS_OUTSIDE_STORAGE variable set. So code defaults to Minio host and port.
Also s3.amazonaws.com works only for us-east-1 . If user wants to specify for some other region he has to prefix the uRL with s3-region-name .

smothiki · 2016-03-07T23:57:30Z

I think you have generalized this for every deis component. The setting are only valid for builder and its components not for other services. ping @bacongobbler for database , @kmala for registry.

smothiki · 2016-03-07T23:58:32Z

src/installing-deis/configuring-object-storage.md

@@ -15,10 +16,42 @@ Additionally, Deis ships with a [Minio](http://minio.io) [component](https://git

 # Telling Deis What to Use

-The Deis components determine what object storage system to use via environment variables that you set up:
+The Deis components determine what object storage system to use via environment variables that you set up. The below list is the lookup order for all Deis components.


@arschles Im good with the PR if you can some how add a special column for builder storage settings. This heading says the below settings are for deis which is not true.

yup, added sections in arschles@238a71f

…iven S3 URL

…o multiple component-specific sections

arschles · 2016-03-08T01:06:37Z

@smothiki I've separated each component into its own section in arschles@238a71f, and left TODOs under deis/database and deis/registry (cc/ @kmala and @bacongobbler)

arschles · 2016-03-08T01:08:06Z

@smothiki also, I've clarified that s3.amazonaws.com is specifically only for us-east-1a in arschles@3b1eb4a

arschles · 2016-03-08T16:55:06Z

@kmala @bacongobbler @smothiki I've removed both LGTMs, since after they were both on, there were a significant amount of comments changes. Can you all do another review?

bacongobbler · 2016-03-08T17:19:46Z

database documentation is a wee bit generic, but it's great that we have this in here so we can point users where to look. I can follow up with more in-depth documentation in the future. 👍

arschles · 2016-03-08T17:24:33Z

@bacongobbler thanks for the honesty (I suspected as much!) - think this is ok to merge, along with an issue to improve these docs?

bacongobbler · 2016-03-08T17:28:33Z

absolutely. This is a great starting point that we can build on top of.

arschles · 2016-03-08T17:30:00Z

k, cool. thanks!

bacongobbler · 2016-03-08T17:43:22Z

closes #29

bacongobbler · 2016-03-08T17:45:53Z

also closes #26

kmala · 2016-03-08T17:53:52Z

src/installing-deis/configuring-object-storage.md

-The only currently known limitation is that [the Deis registry component](https://github.com/deis/registry) will not automatically look up the minio service, nor will it look for other storage env vars. That fix is being tracked in a [GitHub issue](https://github.com/deis/registry/issues/7) and is planned for our beta release.
+Below is a list of known limitations of our components' ability to interact with object storage systems.
+
+- [The Deis registry component](https://github.com/deis/registry) will not automatically look up the Kubernetes Minio service, nor will it look for other storage env vars. That fix is being tracked in a [GitHub issue](https://github.com/deis/registry/issues/7) and is planned for our beta release.


This is no more a limitation.fixed in deis/registry#27

thanks @kmala. removed in arschles@7851b48

…tion that no longer exists

kmala · 2016-03-08T18:23:21Z

src/installing-deis/configuring-object-storage.md

+
+### Credentials
+
+The registry reads the credential information from a `/var/run/secrets/deis/registry/creds/objectstorage-keyfile` file. See https://github.com/deis/charts/blob/master/deis-dev/tpl/deis-objectstorage-secret.yaml for an example of what that file should look like.


Can we write this way: The registry reads the credential information from a /var/run/secrets/deis/registry/creds/objectstorage-keyfile file. This is generated automatically during helm generate based on the configuration options given in the https://github.com/deis/charts/blob/master/deis-dev/tpl/objectstorage.toml.

@kmala ok, changed it in d106a7e. Also changed the DB credentials section to have similar language in fb6131d

…rate language to the DB credentials section

…rate logic to the registry credentials section

jackfrancis · 2016-03-08T22:24:54Z

src/installing-deis/configuring-object-storage.md

+
+### Environment Variables
+
+The builder looks for the below environment variables to determine where the object storage system is. The builder looks in-order for these variables. If it finds two, the one higher in the list will be used.


It might be easier to just explicitly state the preferred variable in the case of all of them being present. E.g.,

If it finds two, DEIS_OUTSIDE_STORAGE will take precedence and external object storage configuration will be applied.

Good idea. Fixed in f575341

…cs less repetitive and more approachable

… generate in backticks

…it" pronoun

…var lookup order also split up paragraph about BUCKET - hopefully that makes it more readable

jackfrancis · 2016-03-08T22:47:31Z

All amendments look good!

arschles · 2016-03-08T22:49:08Z

thanks @kmala @smothiki @jackfrancis @bacongobbler for your reviews

doc(configuring-object-storage.md): add section on storing credentials & GCS

doc(configuring-object-storage.md): add section on storing credential…

ae21387

…s & GCS also adds the database component to the list of things that needs S3

arschles added awaiting review docs labels Mar 5, 2016

arschles self-assigned this Mar 5, 2016

arschles added this to the v2.0-beta1 milestone Mar 5, 2016

slack mentioned this pull request Mar 6, 2016

Bring documentation in-line with Workflow terminology. #72

Merged

mboersma added the LGTM1 label Mar 7, 2016

smothiki reviewed Mar 7, 2016
View reviewed changes

bacongobbler added LGTM2 and removed awaiting review labels Mar 7, 2016

smothiki added the awaiting review label Mar 7, 2016

arschles removed the LGTM2 label Mar 7, 2016

Aaron Schlesinger added 2 commits March 7, 2016 15:05

doc(src/installing-deis/configuring-object-storage.md): remove DEIS_O…

1a0ba70

…UTSIDE_STORAGE_PORT in favor of DEIS_OUTSIDE_STORAGE. also, include examples for outside storage URLs

doc(src/installing-deis/configuring-object-storage.md): add note on t…

6cbee9b

…he BUCKET env var

smothiki reviewed Mar 7, 2016
View reviewed changes

Aaron Schlesinger added 2 commits March 7, 2016 16:39

doc(src/install-deis/configuring-object-storage.md): clarifying the g…

3b1eb4a

…iven S3 URL

doc(src/installing-deis/configuring-object-storage.md): splitting int…

238a71f

…o multiple component-specific sections

bacongobbler added the LGTM1 label Mar 8, 2016

kmala reviewed Mar 8, 2016
View reviewed changes

doc(src/installing-deis/configuring-object-storage.md): remove limita…

7851b48

…tion that no longer exists

kmala reviewed Mar 8, 2016
View reviewed changes

Aaron Schlesinger added 2 commits March 8, 2016 11:47

doc(src/installing-deis/configuring-object-storage.md): add helm gene…

fb6131d

…rate language to the DB credentials section

fix(src/installing-deis/configuring-object-storage.md): add helm gene…

d106a7e

…rate logic to the registry credentials section

jackfrancis reviewed Mar 8, 2016
View reviewed changes

Aaron Schlesinger added 4 commits March 8, 2016 14:36

doc(src/installing-deis/configuring-object-storage.md): making GCS do…

a5aa132

…cs less repetitive and more approachable

doc(src/installing-deis/configuring-object-storage.md): surround helm…

30527a1

… generate in backticks

doc(src/installing-deis/configuring-object-storage.md): clarify the "…

ce16189

…it" pronoun

docs(src/installing-deis/configuring-object-storage.md): clarify env …

f575341

…var lookup order also split up paragraph about BUCKET - hopefully that makes it more readable

jackfrancis added the LGTM2 label Mar 8, 2016

arschles added a commit that referenced this pull request Mar 8, 2016

Merge pull request #68 from arschles/s3-docs

442a9a9

doc(configuring-object-storage.md): add section on storing credentials & GCS

arschles merged commit 442a9a9 into deis:master Mar 8, 2016

arschles deleted the s3-docs branch March 8, 2016 22:49

arschles removed the awaiting review label Mar 8, 2016

This was referenced Mar 11, 2016

Document how to set up the object storage system of choice for a new Deis cluster #26

Closed

add documentation for running postgres backed by S3 #29

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc(configuring-object-storage.md): add section on storing credentials & GCS #68

doc(configuring-object-storage.md): add section on storing credentials & GCS #68

arschles commented Mar 5, 2016

smothiki Mar 7, 2016

arschles Mar 7, 2016

smothiki Mar 7, 2016

arschles Mar 7, 2016

smothiki commented Mar 7, 2016

smothiki commented Mar 7, 2016

bacongobbler commented Mar 7, 2016

smothiki commented Mar 7, 2016

arschles commented Mar 7, 2016

smothiki commented Mar 7, 2016

smothiki commented Mar 7, 2016

arschles commented Mar 7, 2016

arschles commented Mar 7, 2016

smothiki commented Mar 7, 2016

smothiki commented Mar 7, 2016

smothiki Mar 7, 2016

arschles Mar 8, 2016

arschles commented Mar 8, 2016

arschles commented Mar 8, 2016

arschles commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

arschles commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

arschles commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

kmala Mar 8, 2016

arschles Mar 8, 2016

kmala Mar 8, 2016

arschles Mar 8, 2016

jackfrancis Mar 8, 2016

arschles Mar 8, 2016

jackfrancis commented Mar 8, 2016

arschles commented Mar 8, 2016


		As you may know Google Cloud Storage (GCS) can [interoperate with the S3 API](https://cloud.google.com/storage/docs/interoperability), and, if you choose to use Google Cloud Storage for object storage, you'll have to turn on this interoperability mode.

		If you choose to use Google Cloud Storage, set your `DEIS_OUTSIDE_STORAGE_HOST` environment variable to `storage.googleapis.com`, and follow [these instructions](https://cloud.google.com/storage/docs/migrating?hl=en_US#keys) to generate an S3 compatible access key ID and access key secret. Store these credentials just as you would if they were AWS S3 or Minio credentials (see the "Storing Credentials" section above).


		### Credentials

		The registry reads the credential information from a `/var/run/secrets/deis/registry/creds/objectstorage-keyfile` file. See https://github.com/deis/charts/blob/master/deis-dev/tpl/deis-objectstorage-secret.yaml for an example of what that file should look like.


		### Environment Variables

		The builder looks for the below environment variables to determine where the object storage system is. The builder looks in-order for these variables. If it finds two, the one higher in the list will be used.

doc(configuring-object-storage.md): add section on storing credentials & GCS #68

doc(configuring-object-storage.md): add section on storing credentials & GCS #68

Conversation

arschles commented Mar 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smothiki commented Mar 7, 2016

smothiki commented Mar 7, 2016

bacongobbler commented Mar 7, 2016

smothiki commented Mar 7, 2016

arschles commented Mar 7, 2016

smothiki commented Mar 7, 2016

smothiki commented Mar 7, 2016

arschles commented Mar 7, 2016

arschles commented Mar 7, 2016

smothiki commented Mar 7, 2016

smothiki commented Mar 7, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arschles commented Mar 8, 2016

arschles commented Mar 8, 2016

arschles commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

arschles commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

arschles commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

bacongobbler commented Mar 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackfrancis commented Mar 8, 2016

arschles commented Mar 8, 2016