Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added additional documentation #1

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Added additional documentation #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
893bdca
Added notes for installing on debian
chuxau Apr 15, 2015
4fcfbd1
Cleaned up the linux oriented notes
chuxau Apr 15, 2015
19958a2
More tidying up
chuxau Apr 15, 2015
494c71a
More edits
chuxau Apr 15, 2015
a0df87e
Added some post-install notes
chuxau Apr 15, 2015
2c85353
Moved post-install to its own file
chuxau Apr 15, 2015
c0f1853
Created a new post-install file
chuxau Apr 15, 2015
e6c9b08
Merge pull request #2 from chuxau/chuxau-debian-notes-patch-1
chuxau Apr 15, 2015
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
28 changes: 28 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,31 @@ Valkyrie also uses git quite extensively. So if you don't already have it
installed, go ahead and do that next.

* http://git-scm.com/downloads

### Notes for Linux
**NFS server installed on the host is a requirement for valkyrie**
* On Debian/Ubuntu based distributions, install the nfs-kernel-server package.
* On RedHat based distributions, here is a [good guide](http://computernetworkingnotes.com/network-administration/how-to-configure-nfs-server-in-rhel-6.html) for installing and configuring the nfs server.

**Authorize NFS connections through your host's firewall to the VM**
Copy link
Member

Choose a reason for hiding this comment

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

Everything below this point should probably go in a separate 'Troubleshooting' page.

* Here is a [debian oriented guide](https://wiki.debian.org/SecuringNFS) to force the NFS daemons to run on known ports so you can configure the host's firewall appropriately
* Here is a [redhat oriented guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/s2-nfs-nfs-firewall-config.html) for forcing NFS to run on known ports.
* If you use ufw as your firewall frontend, and you are not that bothered about trusting an embedded VM network, then allow the entire VM network
```
sudo ufw allow from 10.42.0.0/24
sudo ufw allow to 10.42.0.0/24
```
**Fix nfs install issues on Debian**

On Debian wheezy/squeeze, if you encounter errors like the following while installing nfs packages:
```
insserv: Service portmap has to be enabled to start service nfs-common
insserv: exiting now!
update-rc.d: error: insserv rejected the script header
```
This is caused by the fact that debian nfs packages are transitioning from using portmapper to using rpcbind, but the package maintainers have not effected the required changes in the init.d scripts. You can fix this by:
```
cd /etc/init.d
sudo sed -i 's%$portmapper%$rpcbind%g' nfs-common nfs-kernel-server umountnfs.sh
sudo apt-get -f install
```
61 changes: 61 additions & 0 deletions docs/post-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Post-install
------------

**Important installer messages**

At the end of the installation process, the installer will display messages like:
```
==> valkyrie: TASK: [getvalkyrie.valkyrie | Output the deploy key] **************************
==> valkyrie: ok: [localhost] => {
==> valkyrie: "var": {
==> valkyrie: "ssh_public_key_output.stdout_lines": [
==> valkyrie: "/////////////////////////////////////////////////////////////////////////////",
==> valkyrie: " Add the following deploy key to your project on Github:",
==> valkyrie: "=============================================================================",
==> valkyrie: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCosL1qmesmA55S2ZB3fEdsLQSElHOARcXpu7ZeT5vX+kpKb6OQQ/6zQ9I5nx1GaZORkwlKy4qNxhmUiy7u/aIiPALQlL2m9y7brqFxewPMCcX5vhV84rW/qxieJzx3nSC0s99ui+vnYhylbwBapJmfpUcuCMJzyP+JlusRYTLyk/uIrDtewnk2PgAtFYF/gUyK6It/RIbwdtawXrW/MQuFuYPpVYnvG+bbqmx+t7HBISWBbm/DK2guKhXzkUhdD24sdPp9tjUfLfsWYB3Plh5mhOM8I4cTwjVOxGwVfwC+KiEAxlRbSihsqUaRdIr7AXfZ4pG/b6MelwlcX3W61tvz Valkyrie deploy key",
==> valkyrie: "=============================================================================",
==> valkyrie: "/////////////////////////////////////////////////////////////////////////////"
==> valkyrie: ]
==> valkyrie: }
==> valkyrie: }
==> valkyrie:
==> valkyrie: TASK: [getvalkyrie.valkyrie | Output the login link] **************************
==> valkyrie: ok: [localhost] => {
==> valkyrie: "var": {
==> valkyrie: "aegir_login_link_output.stdout_lines": [
==> valkyrie: "/////////////////////////////////////////////////////////////////////////////",
==> valkyrie: " You can access the front-end of your Aegir install at:",
==> valkyrie: "=============================================================================",
==> valkyrie: "http://valkyrie.local/user/reset/1/1429111863/uAvC9VJx-l2CqhaufWg8ElCSFWzfdTiUTxJOQJ-pbz4/login",
==> valkyrie: "=============================================================================",
==> valkyrie: "/////////////////////////////////////////////////////////////////////////////"
==> valkyrie: ]
==> valkyrie: }
==> valkyrie: }
```

* Use the login link as a one-time access to the now deployed aegir frontend, and reset the admin password immediate. Don't forget to tick the check boxes for all the roles you would want the admin user to be able to play on the aegir server.
Copy link
Member

Choose a reason for hiding this comment

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

Resetting the admin password isn't required. The password is random (and thus secure) at this point, and the session opened by clicking on the one-time password link will continue to grant access. If the session times-out, you need only run drush @v uli on the host to be logged in again.

Setting roles isn't required either, since the user is UID1.

* Copy the displayed deploy ssh key, and add it to your project on github. This will allow you to publish to the project from valkyrie.

### Looking Around the system

**The directory in which vagrant commands are executed is significant**
* The default location for vagrant base boxes is ~/.vagrant/machine, but valkyrie does not use that
Copy link
Member

Choose a reason for hiding this comment

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

this is not the case, nor does valkyrie change Vagrant's default behaviour.

* The base directory for valkyrie vagrant vm is the directory in which you invoked the command `drush vmnew valkyrie`
Copy link
Member

Choose a reason for hiding this comment

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

besides the typo here, this is also incorrect. the 'base directory' is the directory created by this command; so ./valkyrie in this case.

* To see all vagrant instances for your user account, from anywhere type `vagrant global-status` .. the display of this command is cached and might show recently deleted VMs
Copy link
Member

Choose a reason for hiding this comment

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

everything below here is standard Vagrant functionality. I don't think there's any reason to describe it in detail here.

* From anywhere you can run vagrant commands against any vm, by postfixing the id displayed by vagrant global-status. For example:
```
vagrant destroy vmid
vagrant ssh vmid
etc
```
* From a given install base, you can issue vagrant commands without specifying a vm id, and the commands will be run against the vm defined in the Vagrantfile within that directory
* You can further customize the vm, by editing the Vagrant file

**Working in the VM**
Copy link
Member

Choose a reason for hiding this comment

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

The purpose of Valkyrie is largely to remove the need to SSH into the VM. That said, vagrant ssh is, again, standard Vagrant functionality.

What is perhaps interesting is that you can access the VM via Drush, using the generated aliases. drush sa should list a couple special aliases for the vm itself and the Aegir site. drush @v ssh, for example, will SSH you into the VM as the 'aegir' user, which is usually what you'll want, to avoid messing up file permissions and such.

* Logon to the VM, by typing 'vagrant ssh vmid'
* This will log you into the vm's bash shell as user 'vagrant'
* To become root, just type `sudo -s`, or preferably prepend sudo only when you need to run privileged commands
* To see the nfs shares the vm is mounting from the host `df -h -t nfs`
* /var/aegir/platforms is mounted off the host, and you can develop your platform code in that nfs-shared directory on the host .. perhaps define your IDE project space there. Each platform is basically a drupal install tree, which could also be created off makefiles, either from the host or the vm.