Verify all cluster preconditions are documented

cityindex-attic / logsearch

[unmaintained] A development environment for ELK

Apache License 2.0

24 stars 8 forks source link

Verify all cluster preconditions are documented #117

Closed sopel closed 11 years ago

sopel commented 11 years ago

This details #115, and relates to #116 - if the latter works, things look good in principle, but we have already deployed quite some facilitated components manually across all regions (e..g. EC2 key pairs, SNS topics etc.), which should be documented accordingly.

we might also reassess whether some might be integrated into the stack still, but while possible for SNS topics for example, this tends to complicate things, thus shouldn't block progress here if deemed too complex right now

dpb587 commented 11 years ago

Documented in wiki - let me know if it should be written in a different style.

sopel commented 11 years ago

Thanks, that's entirely sufficient for now and the chosen style resembles a nice Quickstart plus pointers for more advanced usage in fact.

down the road it might be helpful to have dependencies documented a bit more reference style as well (for quick reference and easier maintenance by our own and power users), but that can be handled wiki style going forward

sopel commented 11 years ago

Regarding the Quickstart aspect it would also be helpful to add readily copyable CLI fragments (see e.g. the Stackato-Cluster or Visual-Studio-Load-Test-Cluster pages, both of which are a bit too long and using PowerShell though, which we should replace with AWS Command Line Interface based ones here).

This can likewise be added wiki style over time - I'll look into this in the context of #137.

dpb587 commented 11 years ago

I originally did have an aws-cli command in the draft for the standalone template, but I took it out because it strangely felt like it was too simple and people might just copy/paste without realizing what it actually does. If it's useful:

$ aws --region us-east-1 cloudformation create-stack \
    --stack-name "logsearch-example-standalone" \
    --template-url 'http://ci-elasticsearch-development-flow.s3.amazonaws.com/aws-cloudformation/master/composite-example-standalone.template' \
    --parameters \
        parameter_key=AvailabilityZone,parameter_value=us-east-1e \
        parameter_key=CidrRange,parameter_value=`curl -s ifconfig.me`/32 \
        parameter_key=ClusterName,parameter_value='logsearch-example-standalone' \
        parameter_key=KeyName,parameter_value=$AWS_KEYPAIR_NAME
$ open 'https://console.aws.amazon.com/cloudformation/home?region=us-east-1#ConsoleState:viewing=ACTIVE&stack=logsearch-example-standalone&tab=Outputs'