Merge pull request #13265 from chrisroberts/vc-docs-v2

Vagrant Cloud docs update

website/content/docs/boxes/format.mdx

@@ -60,5 +60,7 @@ because it cannot verify the provider.
 
 Other keys/values may be added to the metadata without issue. The value
 of the metadata file is passed opaquely into Vagrant and plugins can make
-use of it. At this point, Vagrant core does not use any other keys in this
+use of it. Values currently used by Vagrant core:
-file.
+
+* `provider` - (string) Provider for the box
+* `architecture` - (string) Architecture of the box

website/content/docs/vagrantfile/machine_settings.mdx

@@ -43,7 +43,7 @@ the name of the synced folder plugin.
   [HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud).
 
 - `config.vm.box_architecture` (string) - The architecture of the box to be used.
-  Supported architecture values: "386", "amd64", "arm", "arm64", "ppc64le", "ppc64",
+  Supported architecture values: "i386", "amd64", "arm", "arm64", "ppc64le", "ppc64",
   "mips64le", "mips64", "mipsle", "mips", and "s390x". The special value `:auto` will
   detect the host architecture and fetch the appropriate box, if available. When the
   value is set to `nil`, it will fetch the box flagged as the default architecture.

website/content/vagrant-cloud/api/v1.mdx

@@ -1,10 +1,10 @@
 ---
 layout: vagrant-cloud
-page_title: Vagrant Cloud API
+page_title: Vagrant Cloud API (Version 1)
 description: "Vagrant Cloud provides an API for users to interact with Vagrant Cloud for experimentation, automation, or building new features and tools on top of our existing application."
 ---
 
-# Vagrant Cloud API
+# Vagrant Cloud API (Version 1)
 
 ## Using the API
 
@@ -18,7 +18,7 @@ Clients can authenticate using an authentication token.
 The token can be passed to Vagrant Cloud one of two ways:
 
 1. (Preferred) Set the `Authorization` header to `"Bearer "` and the value of the authentication token.
-2. Pass the authentication token as an `access_token` URL parameter.
+2. Pass the authentication token as an `access_token` URL parameter (_NOTE_: deprecated).
 
 Examples below will set the header, but feel free to use whichever method is easier for your implementation.
 

website/content/vagrant-cloud/boxes/architecture.mdx

@@ -0,0 +1,117 @@
+---
+layout: vagrant-cloud
+page_title: Vagrant Box Architecture
+description: "Vagrant box architecture and default architecture."
+---
+
+# Architecture for Vagrant boxes
+
+Providers for Vagrant boxes, in Vagrant version 2.4.0 and newer, can include 
+multiple architecture options. This allows you to have multiple instances 
+of one specific provider. The specific provider shares a common name for
+artifacts of different architectures.
+
+For example, the `hashicorp/precise32` and `hashicorp/precise64` boxes each
+include a provider for `virtualbox`.
+
+```
+hashicorp/precise32
+  v1.0.0
+    provider: virtualbox
+    
+hashicorp/precise64
+  v1.0.0
+    provider: virtualbox
+```
+
+The addition of architecture now allows these to be combined into a single
+box. Instead of having a `hashicorp/precise32` box for a 32-bit guest, and 
+a `hashicorp/precise64` box for a 64-bit guest, a single `hashicorp/precise`
+box can provide both.
+
+```
+hashicorp/precise
+  v1.0.0
+    provider: virtualbox, architecture: amd64
+    provider: virtualbox, architecture: i386
+```
+
+The Vagrant CLI will automatically match the provider architecture using the
+detected local host architecture. If the Vagrant CLI cannot find a matching 
+architecture, it will attempt a
+[special case match](/vagrant/vagrant-cloud/boxes/architecture#unknown-architecture).
+
+## Default architecture
+
+Vagrant Cloud allows you to optionally specify one architecture as the
+"default architecture" for a provider. This enables the box owner to 
+control which architecture for the provider the Vagrant CLI uses
+when architecture filtering is not available. By default, the first 
+provider in the configuration for a box version is the default architecture.
+
+Note, this functionality enables backwards compatiblity
+with previous versions of the Vagrant CLI that do not support architecture
+filtering when matching an appropriate provider.
+
+For example, the `2.0.0` version of the `hashicorp/precise` box is created and 
+a new `virtualbox` provider is created with `amd64` architecture.
+
+```
+hashicorp/precise
+  v2.0.0
+    provider: virtualbox, architecture: amd64, default_architecture: true
+```
+
+Adding another `virtualbox` provider with `i386` architecture.
+
+```
+hashicorp/precise
+  v2.0.0
+    provider: virtualbox, architecture: amd64, default_architecture: true
+    provider: virtualbox, architecture: i386, default_architecture: false
+```
+
+When the Vagrant CLI, prior to version 2.4.0, requests the `hashicorp/precise`
+box with the `virtualbox` provider, it will receive the information from 
+the `virtualbox` provider with the `amd64` architecture because it is flagged 
+as being the default architecture. If, instead, the provider with `i386`
+architecture should be returned, the `virtualbox` provider for the `i386` 
+architecture can be updated to be the default architecture.
+
+```
+hashicorp/precise
+  v2.0.0
+    provider: virtualbox, architecture: amd64, default_architecture: false
+    provider: virtualbox, architecture: i386, default_architecture: true
+```
+
+Now the provider with the `i386` architecture will be returned.
+
+## Special cases
+
+There are two cases where Vagrant CLI versions with architecture support
+will use the default architecture flag.
+
+### User requested
+
+If the user sets the [config.vm.box_architecture](/vagrant/docs/vagrantfile/machine_settings#config-vm-box_architecture)
+option in their Vagrantfile to `nil`, the Vagrant CLI will use the 
+provider which has been flagged as the default architecture.
+
+### Unknown architecture
+
+The architecture value `unknown` combined with the default architecture
+flag provides a special matching case for the Vagrant CLI. If the 
+[config.vm.box_architecture](/vagrant/docs/vagrantfile/machine_settings#config-vm-box_architecture)
+option in the local Vagrantfile is configured with the default `:auto`
+value, and no architecture matching the host platform can be found 
+for the desired provider, the Vagrant CLI will check for a matching 
+provider that is flagged as the default architecture and has an
+architecture value of `unknown`. If that match is found, the Vagrant
+CLI will use that provider.
+
+This special case matching was included so the Vagrant CLI would be
+able to use boxes published to Vagrant Cloud prior to the introduction 
+of architecture metadata. All previously existing providers have a 
+default architecture value of `unknown` and are flagged as the default 
+architecture since they are the only provider to exist for a given name.

website/content/vagrant-cloud/boxes/create.mdx

@@ -62,7 +62,7 @@ need to get an [access token](https://vagrantcloud.com/settings/security).
 Then, prepare the upload:
 
 ```shell-session
-$ curl 'https://vagrantcloud.com/api/v1/box/USERNAME/BOX_NAME/version/VERSION/provider/PROVIDER_NAME/upload?access_token=ACCESS_TOKEN'
+$ curl 'https://vagrantcloud.com/api/v2/box/USERNAME/BOX_NAME/version/VERSION/provider/PROVIDER_NAME/ARCHITECTURE_NAME/upload?access_token=ACCESS_TOKEN'
 ```
 
 This should return something like this:
@@ -82,7 +82,7 @@ $ curl -X PUT --upload-file foo.box https://archivist.hashicorp.com/v1/object/63
 When the upload finishes, you can verify it worked by making this request and matching the `hosted_token` it returns to the previously retrieved upload token.
 
 ```shell-session
-$ curl 'https://vagrantcloud.com/api/v1/box/USERNAME/BOX_NAME/version/VERSION_NUMBER/provider/PROVIDER_NAME?access_token=ACCESS_TOKEN'
+$ curl 'https://vagrantcloud.com/api/v2/box/USERNAME/BOX_NAME/version/VERSION_NUMBER/provider/PROVIDER_NAME/ARCHITECTURE_NAME?access_token=ACCESS_TOKEN'
 ```
 
 Your box should then be available for download.

website/data/vagrant-cloud-nav-data.json

@@ -18,6 +18,10 @@
         "title": "Creating a New Version",
         "path": "boxes/create-version"
       },
+      {
+        "title": "Box Provider Architecture",
+        "path": "boxes/architecture"
+      },
       {
         "title": "Distributing",
         "path": "boxes/distributing"
@@ -88,6 +92,15 @@
   },
   {
     "title": "API",
-    "path": "api"
+    "routes": [
+      {
+        "title": "v2",
+        "path": "api/v2"
+      },
+      {
+        "title": "v1",
+        "path": "api/v1"
+      }
+    ]
   }
 ]