Skip to content
This repository has been archived by the owner on May 6, 2020. It is now read-only.

doc(*): strike all references to deisctl #163

Merged
merged 1 commit into from
Dec 29, 2015
Merged

doc(*): strike all references to deisctl #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ pages:
- System Requirements: installing-deis/system-requirements.md
- Bare Metal: installing-deis/bare-metal.md
- DigitalOcean: installing-deis/digitalocean.md
- Installing deisctl: installing-deis/installing-deisctl.md
- Installing the Deis Platform: installing-deis/installing-the-deis-platform.md
- Using Deis:
- Installing the Client: using-deis/installing-the-client.md
Expand Down
1 change: 0 additions & 1 deletion docs/src/contributing/triaging-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ security | Security-related issues such as TLS encryption, network segregati
- client
- controller
- database
- deisctl
- docs
- kubernetes
- registry
Expand Down
4 changes: 0 additions & 4 deletions docs/src/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,4 @@ DAY-iss

Unofficial documentation in Chinese has been created by the DockerOne community.

### What's the difference between the `deis` and `deisctl` clients?

deis is a "dev" tool, used to deploy and scale applications to a Deis Platform. deisctl is an "ops" tool, used to configure and manage the Deis Platform itself.

[dais]: https://en.wikipedia.org/wiki/Dais
54 changes: 0 additions & 54 deletions docs/src/installing-deis/installing-deisctl.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docs/src/installing-deis/installing-the-deis-platform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,6 @@ the following is an indicator of success:
Now that you've finished provisioning a cluster, start [Using Deis][] to deploy your first
application on Deis.

[install deisctl]: installing-deisctl.md
[helm]: http://helm.sh
[using deis]: ../using-deis/deploying-an-application.md
[configure dns]: ../managing-deis/configuring-dns.md
2 changes: 1 addition & 1 deletion docs/src/roadmap/release-schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ defined as:

- the REST API for *deis-controller*
- etcd keys and values that are publicly documented
- `deis` and `deisctl` commands and options
- `deis` commands and options
- essential `Makefile` targets
- provider scripts under `contrib/`

Expand Down
1 change: 0 additions & 1 deletion docs/src/roadmap/test-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ Within the scope of this master test plan are these items:
- The assembled Deis platform on a Kubernetes cluster
- The HTML documentation set for Deis
- Binary installers for the `deis` CLI hosted at AWS S3
- Binary installers for the `deisctl` CLI hosted at AWS S3
- Hosted HTML documentation updates at http://docs.deis.io/
- Docker images hosted at <https://registry.hub.docker.com/repos/deis/>

Expand Down
3 changes: 2 additions & 1 deletion docs/src/understanding-deis/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ grouped into a Control Plane, Data Plane and Router Mesh.

![Deis System Diagram](DeisSystemDiagram.png)

Operators use the `Deisctl API` to stand up the cluster's Control Plane, Data Plane and Router Mesh.
Operators use [Helm][] to stand up the cluster's Control Plane, Data Plane and Router Mesh.
End-users of the platform interact with the Control Plane using the `Deis API`.

The Control Plane dispatches work to the Data Plane via a scheduler.
Expand Down Expand Up @@ -65,6 +65,7 @@ See [Isolating the Planes][isolating-planes] for further details.
[applications]: ../reference-guide/terms.md#application
[builder]: components.md#builder
[components]: components.md
[helm]: http://helm.sh
[containers]: ../reference-guide/terms.md#container
[controller]: components.md#controller
[database]: components.md#database
Expand Down
10 changes: 2 additions & 8 deletions docs/src/using-deis/registering-a-user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To use Deis, you must first register a user on the [Controller][].
Use `deis register` with the [Controller][] URL (supplied by your Deis administrator)
to create a new account. You will be logged in automatically.

The domain you use here should match the one you set with `deisctl config platform set domain=`.
The domain you use here should match the platform domain you selected when configuring the [Router][].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does deis/router#67 change the recommendation to use a platform domain? Not blocking for this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like what deis/router#67 accomplished, but imo "platform domain" is still a thing that operators should care about. In v1.x, you couldn't even install Deis without selecting a platform domain.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

honestly the platform domain in v1 was just visual (it was only used for deis open and the URL after performing a git push deis master), so I'm not sure why we enforced it to be a requirement, but yeah I agree this is good. It's still something operators might want to be aware of.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, fair enough, and very helpful explanations. Thanks @krancour and @bacongobbler

Note that you always use `deis.<domain>` to communicate with the controller.

$ deis register http://deis.example.com
Expand All @@ -19,13 +19,6 @@ Note that you always use `deis.<domain>` to communicate with the controller.
Registered myuser
Logged in as myuser

!!! note
For Vagrant clusters: `deis register http://deis.local3.deisapp.com`

!!! note
The subdomain can be customized by using `deisctl config controller set subdomain=foo`. The
router will then route requests from `foo.<domain>` to the controller.

!!! important
The first user to register with Deis receives "superuser" privileges. Additional users who
register will be ordinary users. It's also possible to disable user registration after creating
Expand Down Expand Up @@ -73,3 +66,4 @@ If you already have an account, use `deis login` to authenticate against the Dei


[controller]: ../understanding-deis/components.md#controller
[router]: ../understanding-deis/components.md#router