Merge lp:~ralsina/tanuki-agent/flip-switch into lp:tanuki-agent

Proposed by Roberto Alsina
Status: Merged
Approved by: Roberto Alsina
Approved revision: 202
Merged at revision: 202
Proposed branch: lp:~ralsina/tanuki-agent/flip-switch
Merge into: lp:tanuki-agent
Diff against target: 154 lines (+7/-7)
1 file modified
docs/notes.md (+7/-7)
To merge this branch: bzr merge lp:~ralsina/tanuki-agent/flip-switch
Reviewer Review Type Date Requested Status
Roberto Alsina (community) Approve
Review via email: mp+281683@code.launchpad.net

Commit message

Switch docs to default to the orgless versions.

Description of the change

Switch docs to default to the orgless versions.

To post a comment you must log in.
Revision history for this message
Roberto Alsina (ralsina) wrote :

self-approving obvious

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== renamed file 'docs/agent-reference.md' => 'docs/agent-reference-orgs.md'
=== renamed file 'docs/agent-reference-products.md' => 'docs/agent-reference.md'
=== renamed file 'docs/api-reference.md' => 'docs/api-reference-orgs.md'
=== renamed file 'docs/api-reference-products.md' => 'docs/api-reference.md'
=== removed file 'docs/notes.md'
--- docs/notes.md 2015-12-11 16:29:43 +0000
+++ docs/notes.md 1970-01-01 00:00:00 +0000
@@ -1,105 +0,0 @@
1Title: Snappy Product Integration Agent
2Version: 20151030
3
4# Documentation
5
6## Tutorial
7
8Read latest version of the [tutorial](tutorial.html)
9
10## Reference
11
12- [Agent Reference](agent-reference.html)
13- [API Reference](api-reference.html)
14
15
16# SPI Agent Download
17
18Download latest version: [agent.tar.gz](agent.tar.gz)
19
20# Release Notes
21
22## October 30 2015
23
24* Better and more detailed documentation
25
26* More resilient SSH-to-the-RaspberryPi management
27
28## October 27 2015
29
30* The provisioning kit commands in the configuration file should be moved into
31 a separate [provkit] section. Currently the agent will warn if they are still
32 in the [config] section. For backwards compatibility, the old usage is still
33 supported.
34
35## October 15 2015
36
37* Agent will retry network operations 3 times to mitigate transient failures.
38* Agent will pass contents of the [environment] section of its configuration to
39 the provisioning kit scripts as part of their environment.
40
41## September 24 2015
42
43* The SPI system now uses a single HTTPS endpoint: https://spi.canonical.com
44 All other endpoints have been removed.
45* Authentication is now mandatory for all API methods, unless otherwise stated
46 in the API documentation.
47
48## August 27 2015
49
50
51* Agent doesn't provide default organization, configuring it is required
52* Removed test credentials from tutorial, configuration is required
53* By default, use the API gateway, so authentication is mandatory (can still use
54 the alternative old URLs using older versions of the agent for
55 non-auth access until next release)
56
57## August 20 2015
58
59SPI System/API changes:
60
61The SPI system is introducing authentication and organizations.
62
63Authentication is, at this point, only used by the agent (see below), and is not
64mandatory for this cycle. In the next cycle authentication for the agent will become
65mandatory.
66
67Please start setting up accounts, and talk with your SPI contact to create your organization
68and to connect your accounts to it.
69
70Agent changes:
71
72* The agent now supports authenticating using U1 accounts.
73* To authenticate, use ./agent.py --interactive-login (more details in the documentation)
74* Agent retries posting results to mitigate transient network failures
75
76## August 7 2015
77
78SPI System/API changes:
79
80* Production is LIVE! New endpoints can be discovered with the ./agent.py --default-config and in the User Documentation.
81* organization_id is no longer required in POST payloads (in the URL path now)
82* manifest.base_image_reference, image.image_reference, test_spec.test_payload all allow arbitrary JSON values now.
83* New Result Query APIs, see the User Documentation for details.
84* Docs: the System Overview section has been extended to provide more information before having to delve into the API details.
85* [BUG] Docs: fixed a number of incorrect examples.
86* [BUG] Docs: clarified when Manifests are required/optional
87
88Agent changes:
89
90* [BUG] Provisioning kit scripts were not properly invoked with the spi_test_opportunity.json parameter
91* New ./scripts/tutorial.py getting-started script
92* Requires a config file to be specified now.
93* Pass environment variables to provisioning kit
94
95## July 31st 2015
96
97New e2e test scripts, old e2e.py is now e2e-image.py, new e2e-snap-rev.py tests
98the "announce a snap revision" workflow.
99
100## July 21st 2015:
101
102This version changes the names of two fields in the test opportunity data:
103
104* image_url becomes image_reference
105* image_hash becomes image_unique_id
1060
=== renamed file 'docs/notes2.md' => 'docs/notes.md'
--- docs/notes2.md 2015-12-11 16:29:43 +0000
+++ docs/notes.md 2016-01-05 18:06:55 +0000
@@ -5,12 +5,12 @@
55
6## Tutorial6## Tutorial
77
8Read latest version of the [tutorial](tutorial-products.html)8Read latest version of the [tutorial](tutorial.html)
99
10## Reference10## Reference
1111
12 - [Agent Reference](agent-reference-products.html)12 - [Agent Reference](agent-reference.html)
13 - [API Reference](api-reference-products.html)13 - [API Reference](api-reference.html)
1414
15# Deprecated Organization-based Documentation15# Deprecated Organization-based Documentation
1616
@@ -20,13 +20,13 @@
2020
21Documentation for the Organization-based workflows is still available here:21Documentation for the Organization-based workflows is still available here:
2222
23 - [tutorial](tutorial.html)23 - [tutorial](tutorial-orgs.html)
24 - [Agent Reference](agent-reference.html)24 - [Agent Reference](agent-reference-orgs.html)
25 - [API Reference](api-reference.html)25 - [API Reference](api-reference-orgs.html)
2626
27# SPI Agent Download27# SPI Agent Download
2828
29Download latest version: [agent-orgless.tar.gz](agent-orgless.tar.gz)29Download latest version: [agent.tar.gz](agent.tar.gz)
3030
31# Release Notes31# Release Notes
3232
3333
=== renamed file 'docs/tutorial.md' => 'docs/tutorial-orgs.md'
=== renamed file 'docs/tutorial-products.md' => 'docs/tutorial.md'

Subscribers

People subscribed via source and target branches

to all changes: