README.md: Migrate from atomic-ws
[workstation-ostree-config.git] / README.md
1 For some background, see:
2
3  - https://fedoraproject.org/wiki/Workstation/AtomicWorkstation
4  - https://fedoraproject.org/wiki/Changes/WorkstationOstree
5  
6 (Note also this repo obsoletes https://pagure.io/atomic-ws)
7
8 High level design
9 -----------------
10
11 The goal of the system is to be a workstation, using
12 rpm-ostree for the base OS, and a combination of
13 Docker and Flatpak containers, as well as virtualization
14 tools such as Vagrant.
15
16 Status
17 ------
18
19 This project is actively maintained and is ready for use
20 by sophisticated and interested users, but not ready
21 for widespread promotion.
22
23 Installing
24 ----------
25
26 Important!  Don't choose auto-partitioning in the below installer ISO.  You
27 need to change `/home` to be `/var/home`.  A bit more information in
28 this [known issue](https://github.com/rhinstaller/anaconda/issues/800).
29
30 There are ISOs available for [Fedora 26)[https://kojipkgs.fedoraproject.org/compose//branched/]
31 and (rawhide)[https://kojipkgs.fedoraproject.org/compose//rawhide/].
32
33 Important issues:
34 -----------------------
35
36  - [Anaconda autopartitoning](https://github.com/rhinstaller/anaconda/issues/800) - be sure to use `/var/home` instead of `/home`
37  - [flatpak system repo](https://github.com/flatpak/flatpak/issues/113#issuecomment-247022006)
38  
39 Migrating between OSTree repos
40 -------------------------------------
41
42 Enable the 26/27 remotes:
43 ```
44 ostree remote add --if-not-exists --gpg-import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-26-primary fedora-ws-26 https://kojipkgs.fedoraproject.org/compose/ostree/26
45 ostree remote add --if-not-exists --gpg-import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-27-primary fedora-ws-27 https://kojipkgs.fedoraproject.org/compose/ostree/rawhide
46 ```
47 Rebase to rawhide:
48 ```
49 rpm-ostree rebase fedora-ws-27:fedora/rawhide/x86_64/workstation
50 ```
51  
52 Using the system
53 --------------------
54
55 First, try out `rpm-ostree install` to layer additional packages.  For example,
56 `rpm-ostree install powerline`.
57
58 Next, let's try flatpak. Before you do: There's a known flatpak issue on
59 AtomicWS - run [this workaround](https://github.com/flatpak/flatpak/issues/113#issuecomment-247022006),
60 which you only need to do once. After that, [try flatpak](http://flatpak.org/apps.html).
61
62 If you are a developer for server applications,
63 try [oc cluster up](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) to
64 create a local OpenShift v3 cluster.
65
66 Finally, you'll likely want to make one or more "pet" Docker containers,
67 potentially privileged, and use `dnf/yum` inside these. You can use e.g. `-v
68 /srv:/srv` so these containers can share content with your host (such as git
69 repositories). Note that if you want to share content between multiple Docker
70 containers and the host (e.g. your desktop session), you should execute (once):
71
72 ```
73 sudo chcon -R -h -t container_file_t /var/srv
74 ```
75
76 Future work
77 -----------
78
79  - GNOME Software support for both rpm-ostree/flatpak and possibly docker
80  - automated tests that run on this content