Skip to content

Commit

Permalink
more links, minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
hjacobs committed Nov 30, 2015
1 parent 1c0f796 commit 0e8ee6a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 27 deletions.
31 changes: 15 additions & 16 deletions user-guide/hello-world.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,15 @@ First of all clone this example project:
.. code-block:: bash
$ git clone git@github.com:zalando-stups/zalando-cheat-sheet-generator.git
$ cd zalando-cheat-sheet-generator
Create this new application in yourturn:
Create this new application using the :ref:`yourturn` web frontend:

.. code-block:: bash
https://yourturn.stups.example.org
Now you will need to create the ``scm-source.json`` file that refer your docker image to a specific git revision number.

Here more information :ref:`scm-source-json`.
Now you will need to create the :ref:`scm-source-json` file that links your Docker image to a specific git revision number.

.. code-block:: bash
Expand All @@ -45,18 +44,18 @@ Let's start the application and see if all works:

.. code-block:: bash
$ python -m http.server 8000
$ python3 -m http.server 8000
http://localhost:8000/index.html?schema=schema/stups.json
Nice! Let's build the docker images:
Nice! Let's build the Docker images:

Build with the Dockerfile in the repo.

.. code-block:: bash
$ docker build -t pierone.stups.example.org/<your-team>/zalando-cheat-sheet-generator:0.1 .
And now see if is listed locally:
And now see if it is listed locally:

.. code-block:: bash
Expand All @@ -69,21 +68,21 @@ Let's also try if the docker images works!
$ docker run -it pierone.stups.example.org/<your-team>/zalando-cheat-sheet-generator:0.1
# and test with this url: http://localhost:8000/index.html?schema=schema/stups.json
If all works, we are ready to login in pierone and push it.
If all works, we are ready to login in :ref:`pierone` and push it.

.. code-block:: bash
$ pierone login
$ docker push pierone.stups.example.org/<your-team>/zalando-cheat-sheet-generator:0.1
Let's check if we can find it in the pierone repository (login needed if your token expired):
Let's check if we can find it in the Pier One repository (login needed if your token expired):

.. code-block:: bash
$ pierone login
$ pierone tags <your-team> zalando-cheat-sheet-generator
Now let's create the version in yourturn for the application created:
Now let's create the version in YOUR TURN for the application created:

.. code-block:: bash
Expand All @@ -101,19 +100,19 @@ Wait for the first credentials to appear:
Deploy!

List aws account:
List AWS account:

.. code-block:: bash
$ mai list
Login via console to your aws account:
Login via console to your AWS account:

.. code-block:: bash
$ mai login <account-name>
Create a senza definition file for that:
Create a :ref:`senza` definition file for that:

.. code-block:: bash
Expand All @@ -128,14 +127,14 @@ Create a senza definition file for that:
* Use the default mint bucket

.. Caution::
Take the internal LB! We have no OAUTH2 configured!!!
Take the internal LB! We have no OAUTH2 configured!

* and let senza create the security group and IAM role for us.

After this, you can also add a log provider or other configuration,
if you like to encrypt your password check this :ref:`guide <key-encryption>`.

Create your stack.
Create your Cloud Formation stack.

.. code-block:: bash
Expand Down Expand Up @@ -185,7 +184,7 @@ Get instance IP:
$ senza instances zalando-cheat-sheet-generator
Let us piu to the Odd bastion host:
Let us :ref:`piu` to the :ref:`odd` bastion host:

.. code-block:: bash
Expand Down
22 changes: 11 additions & 11 deletions user-guide/key-encryption.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
Key Encryption
==============

Would you like to encrypt your password?
Would you like to encrypt your password or other sensitive configurations?

This procedure is the same for all password (DB, log provider, ...) you will encrypt.
This procedure is the same for all passwords (DB, log provider, ...) you will encrypt.

* Login into aws console.
* Login into AWS console.
* Open the IAM service.
* Click on Role and find the name of your application role (normally app-<application-name>)
* Now go back, or click on the left hand side on encryption keys.

.. Caution::

Select the right region!!!
Select the right region!

* Click on create key
* Add an alias and a description
Expand All @@ -25,7 +25,7 @@ This procedure is the same for all password (DB, log provider, ...) you will enc
* For key usage permission add Shibboleth-PowerUser and the role name of your app (normally app-<application-name>)
* Now you are done!

You will see that your key get's an arn (Amazon resource name):
You will see that your key get's an ARN (Amazon resource name):

.. code-block:: bash
Expand All @@ -51,15 +51,15 @@ If all works we can now repeat the first step without the base64 encryption:
$ aws kms encrypt --key-id $KMS_KEY_ID --plaintext "<here-you-can-paste-your-pwd>" --query CiphertextBlob --output text
and here is our encrypted pwd.
and here is our encrypted password.

.. Important::

You can use the Taupage decription functionality, that allows you to define in senza yaml your property as encrypted.
Taupage will then decrypt the password for you and set the unencrypted value on the same property, for your application.
You can use the :ref:`taupage` decryption functionality, that allows you to define in :ref:`senza` YAML your property as encrypted.
Taupage will then decrypt the password for you and set the unencrypted value on the same property for your application.

To do that define the value in the yaml as:
To do that define the value in the YAML as:

.. code-block:: bash
.. code-block:: yaml
`aws:kms:<here-the-encryption-result>`
my_secret: "aws:kms:<here-the-encryption-result>"

0 comments on commit 0e8ee6a

Please sign in to comment.